-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Docs normalization #18831
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs normalization #18831
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! One of these changes feels unnecessary to me, but the rest LGTM :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure there's a need to change this file -- we just end up with a very small Fix safety
section, and I think the content in that paragraph naturally fits with the content of the preceding two paragraphs. I don't think it's essential that every rule is totally consistent in the docs sections it has.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main reason I did is for the consistency - like what I've been doing, if you are writing a tool to try and detect all rules missing the section, it's a one-off edge case, since in the searching I did I could not find another rule that had this format.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Eh, fair enough. It would certainly be nice to enforce (one day...) in CI that all rules which are sometimes unsafe have a Fix safety
section in their docs explaining why.
Summary
While working on a detector for #15584, I noticed several inconsistencies in the docs, so this PR fixes them.
#[derive(ViolationMetadata)]
#[derive(ViolationMetadata)]
## Fix Safety
instead of## Fix safety
Test Plan
N/A, no functionality/tests affected