Skip to content

Commit 7a1e9f2

Browse files
authored
missing_safety_doc accept uppercase "SAFETY" (#13701)
changelog: [`missing_safety_doc`]: accept uppercase "SAFETY" In [Oxc](https://github.com/oxc-project/oxc)'s codebase, we try to draw attention as clearly as possible to the safety constraints of unsafe code by including an uppercase `# SAFETY` doc comment. Clippy's `missing_safety_doc` lint does not recognise "SAFETY" in upper case, so we also need to include `#[expect(clippy::missing_safety_doc)]` on every unsafe function, to avoid a false positive. Unfortunately this defeats the purpose of the lint, as if someone later removes the safety docs, the lint rule does not trigger. I don't know how common this style of documenting unsafe functions is, but I don't imagine also supporting `# SAFETY` would disturb other users who prefer `# Safety`.
2 parents d3edd05 + d8423ca commit 7a1e9f2

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

clippy_lints/src/doc/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -917,6 +917,7 @@ fn check_doc<'a, Events: Iterator<Item = (pulldown_cmark::Event<'a>, Range<usize
917917
}
918918
let trimmed_text = text.trim();
919919
headers.safety |= in_heading && trimmed_text == "Safety";
920+
headers.safety |= in_heading && trimmed_text == "SAFETY";
920921
headers.safety |= in_heading && trimmed_text == "Implementation safety";
921922
headers.safety |= in_heading && trimmed_text == "Implementation Safety";
922923
headers.errors |= in_heading && trimmed_text == "Errors";

0 commit comments

Comments
 (0)