make a bunch of lints texts adhere to rustc dev guide #5888

matthiaskrgr · 2020-08-10T19:25:33Z

According to the rustc-dev guide: "The text should be matter of fact and avoid capitalization and periods, unless multiple sentences are needed"

changelog: make some lint output adhere to the rustc-dev guide

rust-highfive · 2020-08-10T19:25:37Z

r? @yaahc

(rust_highfive has picked a reviewer for you, use r? to override)

yaahc

🥳

clippy_lints/src/checked_conversions.rs

yaahc · 2020-08-10T19:44:31Z

clippy_lints/src/neg_cmp_op_on_partial_ord.rs

@@ -79,7 +79,7 @@ impl<'tcx> LateLintPass<'tcx> for NoNegCompOpForPartialOrd {
                        cx,
                        NEG_CMP_OP_ON_PARTIAL_ORD,
                        expr.span,
-                        "The use of negated comparison operators on partially ordered \
+                        "the use of negated comparison operators on partially ordered \


this one still has sentences and punctuation but had the initial capitalization removed. I'm not sure which direction to go on this one but we should be consistent.

I was also not sure... The guide says The text should be matter of fact and avoid capitalization and periods, unless multiple sentences are needed which is why I left it mostly untouched.

Makes sense, it looks like you already applied the change to turn the multiple sentences into 1 longer non sentence. I think it might also be okay to revert it back to the original punctuation / capitalization version. I'll leave it up to you to pick which one you prefer.

Once you've made the decision feel free to r+ for me.

I think converting all multi-sentence warnings into uber-long single-sentence warnings would probably hurt readability too much...

clippy_lints/src/neg_cmp_op_on_partial_ord.rs

clippy_lints/src/unwrap.rs

yaahc

actually, caught a few

…ge convention

…or refactoring

…tion

Co-authored-by: Jane Lusby <[email protected]>

matthiaskrgr · 2020-08-10T22:40:38Z

@bors r=yaahc

bors · 2020-08-10T22:40:39Z

📌 Commit 6d0b5e2 has been approved by yaahc

bors · 2020-08-10T22:40:47Z

⌛ Testing commit 6d0b5e2 with merge cc5bfd4...

bors · 2020-08-10T23:00:39Z

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: yaahc
Pushing cc5bfd4 to master...

…atthiaskrgr Add reference to rustc-dev-guide about lint message I think it would be better to add lint message convention to documentation. I referred to #5888 and #5893. changelog: none

matthiaskrgr added 4 commits August 10, 2020 20:55

too-many-lines: make lint adhere to lint message convention

e57aafe

bool-comparison: make lint adhere to lint message convention

0876f17

builtin-type-shadow: make lint adhere to lint message convention

fd379a8

naive_bytecount: make lint adhere to lint message convention

40416c0

rust-highfive assigned yaahc Aug 10, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Aug 10, 2020

yaahc approved these changes Aug 10, 2020

View reviewed changes

yaahc reviewed Aug 10, 2020

View reviewed changes

clippy_lints/src/checked_conversions.rs Outdated Show resolved Hide resolved

yaahc reviewed Aug 10, 2020

View reviewed changes

clippy_lints/src/neg_cmp_op_on_partial_ord.rs Outdated Show resolved Hide resolved

yaahc reviewed Aug 10, 2020

View reviewed changes

clippy_lints/src/unwrap.rs Outdated Show resolved Hide resolved

yaahc suggested changes Aug 10, 2020

View reviewed changes

matthiaskrgr added 17 commits August 10, 2020 23:48

checked-conversions: make lint adhere to lint message convention

9b7ab1d

unnecessary_unwrap, panicking_unwrap: make lints adhere to lint messa…

8679dd3

…ge convention

cmp_null: make lint adhere to lint message convention

3d592b5

default-trait-access: make lint adhere to lint message convention

6b0a6a7

double-comparisons: make lint adhere to lint message convention

ba7a01a

double-parens: make lint adhere to lint message convention and do min…

590b91d

…or refactoring

drop_bounds: make lint adhere to lint message convention

0db5cb1

empty-liner-after-outer-attr: make lint adhere to lint message conven…

2792260

…tion

unneeded-field-pattern: make lint adhere to lint message convention

4418ff1

ref_in_deref: make lint adhere to lint message convention

b36a6c9

unknown: make lint adhere to lint message convention

7954c22

suspicious-arithmetic-impl: make lint adhere to lint message convention

fe37ddb

also change "deprecated-attribute" message

5d69ca5

redundant-static-lifetimes: make lint adhere to lint message convention

3e1e0c9

range-zip-with-len: make lint adhere to lint message convention

81f77a4

path-buf-push-overwrite: make lint adhere to lint message convention

9178363

overflow-check-conditional: make lint adhere to lint message convention

e519bb3

matthiaskrgr added 2 commits August 10, 2020 23:49

neg-multiply: make lint adhere to lint message convention

178da9b

neg-cmp-op-on-partial-ord: make lint adhere to lint message convention

dabf989

matthiaskrgr force-pushed the lints branch from 5357f53 to dabf989 Compare August 10, 2020 21:50

matthiaskrgr and others added 3 commits August 10, 2020 23:57

Update clippy_lints/src/neg_cmp_op_on_partial_ord.rs

c514ff0

Co-authored-by: Jane Lusby <[email protected]>

Update clippy_lints/src/unwrap.rs

1b46e48

Co-authored-by: Jane Lusby <[email protected]>

run cargo dev update-lints

f59ec19

matthiaskrgr force-pushed the lints branch from 77282d9 to f59ec19 Compare August 10, 2020 21:57

yaahc approved these changes Aug 10, 2020

View reviewed changes

update test stderr

6d0b5e2

bors merged commit cc5bfd4 into rust-lang:master Aug 10, 2020

giraffate mentioned this pull request Aug 13, 2020

Add reference to rustc-dev-guide about lint message #5901

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

make a bunch of lints texts adhere to rustc dev guide #5888

make a bunch of lints texts adhere to rustc dev guide #5888

matthiaskrgr commented Aug 10, 2020

rust-highfive commented Aug 10, 2020

yaahc left a comment

yaahc Aug 10, 2020

matthiaskrgr Aug 10, 2020 •

edited

Loading

yaahc Aug 10, 2020 •

edited

Loading

matthiaskrgr Aug 10, 2020

yaahc left a comment

matthiaskrgr commented Aug 10, 2020

bors commented Aug 10, 2020

bors commented Aug 10, 2020

bors commented Aug 10, 2020

make a bunch of lints texts adhere to rustc dev guide #5888

make a bunch of lints texts adhere to rustc dev guide #5888

Conversation

matthiaskrgr commented Aug 10, 2020

rust-highfive commented Aug 10, 2020

yaahc left a comment

Choose a reason for hiding this comment

yaahc Aug 10, 2020

Choose a reason for hiding this comment

matthiaskrgr Aug 10, 2020 • edited Loading

Choose a reason for hiding this comment

yaahc Aug 10, 2020 • edited Loading

Choose a reason for hiding this comment

matthiaskrgr Aug 10, 2020

Choose a reason for hiding this comment

yaahc left a comment

Choose a reason for hiding this comment

matthiaskrgr commented Aug 10, 2020

bors commented Aug 10, 2020

bors commented Aug 10, 2020

bors commented Aug 10, 2020

matthiaskrgr Aug 10, 2020 •

edited

Loading

yaahc Aug 10, 2020 •

edited

Loading