Caution against warn(clippy::nursery).
#14391
Conversation
I have seen beginners try to improve their code by writing `#[warn(clippy::pedantic, clippy::nursery)`, and then be confused. The README already warns against enabling all of `restriction`, but it should also warn against `nursery` (in less strong language). I also moved `clippy::restriction` and `clippy::nursery` to the bottom of the table, because these are more special categories than `clippy::cargo`.
rustbot
added
the
S-waiting-on-review
| lint is choosing to program in a restricted subset of Rust for a special purpose.[^restrict] | ||
|
|
||
| * The `nursery` category contains lints which are not yet ready to be in another category. | ||
| If you enable this whole category, be prepared for false positives or incorrect suggestions. |
There was a problem hiding this comment.
Maybe add something like "We welcome bug reports and comments concerning those lints, as this may help towards deciding whether they are ready to be moved into more appropriate categories.", just so people don't refrain themselves when hesitating to file a bug report.
There was a problem hiding this comment.
Hm, is that really accurate? Whenever I see discussions of whether to put a lint in nursery or remove it, it’s “we know the algorithm for this lint has a specific flaw”.
There was a problem hiding this comment.
I would say that if a bug has too many reports, or as you say a specific flaw, we may keep it longer (forever?) in nursery.
|
r? @flip1995 |
There was a problem hiding this comment.
We already have documentation about this in the book. I would prefer if the readme would just link to that documentation:
To learn more about Clippy's lint groups, refer to the Clippy book.
rustbot
added
S-waiting-on-author
I have seen beginners try to improve their code by writing
#[warn(clippy::pedantic, clippy::nursery)], and then be confused. The README already warns against enabling all ofrestriction, but it now also warns againstnursery(in less strong language), and mentions false positives in the one-line summary.I also moved
clippy::restrictionandclippy::nurseryto the bottom of the table, because these are more special meta-categories thanclippy::cargois.changelog: none