Configuration: Add too_long_first_doc_paragraph lint to the check-private-items list - #17476
Configuration: Add too_long_first_doc_paragraph lint to the check-private-items list#17476bradjc wants to merge 2 commits into
too_long_first_doc_paragraph lint to the check-private-items list#17476Conversation
|
Thanks for the pull request, and welcome! You should hear from one of our reviewers after this PR gets at least 2 reviews from the community. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
community review: Yep, that is how it works. 👍🏻
To save others the search:
rust-clippy/clippy_lints/src/doc/too_long_first_doc_paragraph.rs
Lines 10 to 21 in 9117fa7
33cd735 to
cfd40a5
Compare
This comment has been minimized.
This comment has been minimized.
|
I just rebased after the recent conf reformat. |
This comment has been minimized.
This comment has been minimized.
When enabling the `check-private-items` configuration option, the setting affects the too_long_first_doc_paragraph lint, however, that is not documented. This adds the lint to the list in the configuration file. https://doc.rust-lang.org/clippy/lint_configuration.html#check-private-items
cfd40a5 to
31987e1
Compare
|
This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
I enabled the
check-private-itemsconfiguration option and I found that the setting affects thetoo_long_first_doc_paragraphlint, however, that is not documented. I believe this change adds the connection between the lint and the configuration option so that it will show up in the docs.The line became more than 120 characters so I believe I formatted it correctly on multiple lines, following the
msrvexample. Also, I preserved the alphabetical ordering.changelog: [
too_long_first_doc_paragraph]: addcheck-private-itemsas documented config option.