You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This changes the lint introduced in #7748 to suggest adding a SAFETY comment instead of a Safety comment.
Searching for // Safety: in rust-lang/rust yields 67 results while // SAFETY: yields 1072.
I think it's safe to say that this comment tag is written in upper case, just like TODO, FIXME and so on are. As such I would expect this lint to follow the official convention as well.
Note that I intentionally introduced some casing diversity in tests/ui/undocumented_unsafe_blocks.rs to test more cases than just Safety:.
changelog: Capitalize SAFETY comment in [undocumented_unsafe_blocks]
I like standardizing the capitalization. 👍 You might also want to take a look at the missing_safety_doc lint. That one lints missing safety heading in doc comments. 🙃
@xFrednet I think in that case /// # Safety is fine as-is because it denotes a markdown section like e.g. /// # Examples does (which is not uppercased either). I believe that and this comment tag // SAFETY: which is directly followed by the explanation about why it is safe are two slightly different things.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
S-waiting-on-reviewStatus: Awaiting review from the assignee but also interested parties
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This changes the lint introduced in #7748 to suggest adding a
SAFETYcomment instead of aSafetycomment.Searching for
// Safety:in rust-lang/rust yields 67 results while// SAFETY:yields 1072.I think it's safe to say that this comment tag is written in upper case, just like
TODO,FIXMEand so on are. As such I would expect this lint to follow the official convention as well.Note that I intentionally introduced some casing diversity in
tests/ui/undocumented_unsafe_blocks.rsto test more cases than justSafety:.changelog: Capitalize
SAFETYcomment in [undocumented_unsafe_blocks]