Add lint writing documentation #3824

phansch · 2019-02-26T20:00:17Z

This adds a new documentation page that explains how to write Clippy
lints. It guides the reader through creating a foo function lint.

I plan to iterate a bit more on the prose of some sections, but I think the
general structure is fine now, so I'm looking forward to feedback =)

One thing I'm not sure about: I felt like this is too big for CONTRIBUTING.md
so I put it into a new doc/ directory. I can imagine having more
documentation in the future, so we might even want to create a book using
mdbook instead? Or should everything go into CONTRIBUTING.md?

Further things left to do:

Link from CONTRIBUTING.md
Remove things covered in this guide from CONTRIBUTING.md
Section about clippy::author attribute
Run remark-lint on CI over the doc directory and fix things

Manishearth · 2019-02-27T03:43:50Z

This looks really good so far, thanks for doing this!!

As an aside: We should probably build a longer version of the lint naming conventions, we have a bunch of our own (like useless_foo). https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints is pretty basic

detrumi

Good stuff! A few comments after reading through

doc/adding_lints.md

flip1995

First off, thanks for the great work, this document will be really useful!

Maybe also mention the #[clippy::author] attribute.

In the future I would like a section "Advanced Lints", where some other useful things are mentioned and explained. I'm thinking of:

Visitor
LateLintPass example
PreExpansionPass
Constants
MIR-Lints
???

Or we can add additional documentation files for this, to keep this one short (which is probably the better idea)

doc/adding_lints.md

phansch · 2019-02-28T06:25:54Z

Thanks for the reviews so far! I added a small TODO list to the PR description. I will fix those and give it another read/try later today.

In the future I would like a section "Advanced Lints", where some other useful things are mentioned and explained. I'm thinking of: Visitor, LateLintPass example, PreExpansionPass, Constants, MIR-Lints

These are all good ideas! I hope having the documentation in it's own directory lowers the bar a tiny bit for new documentation. I found that working with the existing CONTRIBUTING.md was getting a bit unpleasant.

phansch · 2019-03-01T06:46:50Z

I didn't have time to re-read the whole thing yet and try it out, but I think I addressed all the remaining issues, including the cleanup of CONTRIBUTING.md.

doc/adding_lints.md

felix91gr · 2019-03-01T17:56:36Z

Whaaat! This PR is awesome 😍 there's so much info I learned this last week as I got started, that you've neatly put together here. Thanks! This will surely help a lot of people 😊

This adds a new documentation page that explains how to write Clippy lints. It guides the reader through creating a `foo` function lint.

Co-Authored-By: phansch <[email protected]>

And adapt the wording a bit so that it fits in the overall guide.

This is now all included in `doc/adding_lints.md`

felix91gr · 2019-03-04T00:38:36Z

Have you seen this? Maybe it'd be nice to connect it with this PR :D

phansch · 2019-03-04T20:03:14Z

Have you seen this? Maybe it'd be nice to connect it with this PR :D

Yup, I just cleaned that up a bit and added a 'Done' column and created #3843.

Apart from that, I think this PR is ready for a final review. The rest can be done in subsequent PRs.

doc/adding_lints.md

flip1995

Just skimmed over the new document and I vote for merging this.

phansch · 2019-03-09T15:05:35Z

Going to go ahead and get this merged then, we can still improve it going forward ✨

@bors r+

bors · 2019-03-09T15:05:36Z

📌 Commit 34685a5 has been approved by phansch

bors · 2019-03-09T15:05:44Z

⌛ Testing commit 34685a5 with merge 920112d...

Add lint writing documentation [Rendered](https://github.com/phansch/rust-clippy/blob/adding_lints/doc/adding_lints.md) This adds a new documentation page that explains how to write Clippy lints. It guides the reader through creating a `foo` function lint. I plan to iterate a bit more on the prose of some sections, but I think the general structure is fine now, so I'm looking forward to feedback =) One thing I'm not sure about: I felt like this is too big for CONTRIBUTING.md so I put it into a new `doc/` directory. I can imagine having more documentation in the future, so we might even want to create a book using mdbook instead? Or should everything go into CONTRIBUTING.md? Further things left to do: - [x] Link from CONTRIBUTING.md - [x] Remove things covered in this guide from CONTRIBUTING.md - [x] Section about `clippy::author` attribute - [x] Run `remark-lint` on CI over the `doc` directory and fix things

bors · 2019-03-09T15:25:15Z

☀️ Test successful - checks-travis, status-appveyor
Approved by: phansch
Pushing 920112d to master...

detrumi reviewed Feb 27, 2019

View reviewed changes

doc/adding_lints.md Outdated Show resolved Hide resolved

doc/adding_lints.md Outdated Show resolved Hide resolved

doc/adding_lints.md Outdated Show resolved Hide resolved

flip1995 reviewed Feb 27, 2019

View reviewed changes

doc/adding_lints.md Outdated Show resolved Hide resolved

doc/adding_lints.md Outdated Show resolved Hide resolved

doc/adding_lints.md Show resolved Hide resolved

flip1995 mentioned this pull request Feb 28, 2019

New lint: replace x.get(x.len()-1) with x.last() #3673

Closed

phansch added the S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) label Mar 1, 2019

oli-obk reviewed Mar 1, 2019

View reviewed changes

doc/adding_lints.md Show resolved Hide resolved

doc/adding_lints.md Outdated Show resolved Hide resolved

flip1995 reviewed Mar 1, 2019

View reviewed changes

doc/adding_lints.md Show resolved Hide resolved

phansch mentioned this pull request Mar 2, 2019

Provide an easy way for contributors to run cargo fmt like it's executed on CI #3835

Closed

phansch and others added 15 commits March 3, 2019 15:03

Add lint writing documentation

12b2696

This adds a new documentation page that explains how to write Clippy lints. It guides the reader through creating a `foo` function lint.

Implicit return

c83b029

Co-Authored-By: phansch <[email protected]>

Implicit return

ef97c13

Co-Authored-By: phansch <[email protected]>

Expand on lint implementation section, wrap lines

2851f9f

Use positive if condition for readability

9ff1340

Remind to run update-all-references.sh at the end

81ad442

Mention Clippy utils

ca35e67

Copy from CONTRIBUTING.md: author lint, rustfix tests, rustfmt

68d04ed

And adapt the wording a bit so that it fits in the overall guide.

Cleanup 'Writing code' in CONTRIBUTING.md

1eac53b

This is now all included in `doc/adding_lints.md`

Run remark in doc directory, too.

680dc8a

Author lint usage via playground

81f47e1

Note that stderr files don't have to be created manually

b030114

Reword 'Setup' a bit

0da3521

More text fixes after Test section was moved to top

23f3256

Add the rustc guide to the cheatsheet

8d2cbb9

phansch force-pushed the adding_lints branch from e9d37ca to 8d2cbb9 Compare March 3, 2019 14:03

s/you/we; One more checklist item

d1caaa4

phansch changed the title ~~[WIP] Add lint writing documentation~~ Add lint writing documentation Mar 4, 2019

Add rustc nightly docs to cheatsheet

3c67c62

phansch added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties and removed S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) labels Mar 4, 2019

phansch mentioned this pull request Mar 4, 2019

Docs: Create a page with info on how to do common things #3843

Closed

5 tasks

phansch commented Mar 6, 2019

View reviewed changes

doc/adding_lints.md Outdated Show resolved Hide resolved

phansch added S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties labels Mar 6, 2019

Update comment location

34685a5

phansch added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties and removed S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) labels Mar 8, 2019

flip1995 approved these changes Mar 9, 2019

View reviewed changes

bors merged commit 34685a5 into rust-lang:master Mar 9, 2019

phansch deleted the adding_lints branch March 9, 2019 17:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add lint writing documentation #3824

Add lint writing documentation #3824

phansch commented Feb 26, 2019 •

edited

Loading

Manishearth commented Feb 27, 2019

detrumi left a comment

flip1995 left a comment •

edited

Loading

phansch commented Feb 28, 2019

phansch commented Mar 1, 2019

felix91gr commented Mar 1, 2019

felix91gr commented Mar 4, 2019

phansch commented Mar 4, 2019

flip1995 left a comment

phansch commented Mar 9, 2019

bors commented Mar 9, 2019

bors commented Mar 9, 2019

bors commented Mar 9, 2019

Add lint writing documentation #3824

Add lint writing documentation #3824

Conversation

phansch commented Feb 26, 2019 • edited Loading

Manishearth commented Feb 27, 2019

detrumi left a comment

Choose a reason for hiding this comment

flip1995 left a comment • edited Loading

Choose a reason for hiding this comment

phansch commented Feb 28, 2019

phansch commented Mar 1, 2019

felix91gr commented Mar 1, 2019

felix91gr commented Mar 4, 2019

phansch commented Mar 4, 2019

flip1995 left a comment

Choose a reason for hiding this comment

phansch commented Mar 9, 2019

bors commented Mar 9, 2019

bors commented Mar 9, 2019

bors commented Mar 9, 2019

phansch commented Feb 26, 2019 •

edited

Loading

flip1995 left a comment •

edited

Loading