Clippy lints / Restriction
Clippy lint · Restriction · checked with Clippy 0.1.99
clippy::unnecessary_safety_doc: Checks for the doc comments of publicly visible safe functions and traits and warns if there is a # Safety section
What it meansChecks for the doc comments of publicly visible safe functions and traits and warns if there is a # Safety section. It is in the restriction group and off by default.
Does it matter?
Safe functions and traits are safe to implement and therefore do not need to describe safety preconditions that users are required to uphold.
Lints that forbid language features for specific codebases (no unwrap, no indexing...). Off by default; pick them one by one, never the whole group.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
/// # Safety
///
/// This function should not be called before the horsemen are ready.
pub fn start_apocalypse_but_safely(u: &mut Universe) {
unimplemented!();
}
Write this instead
/// This function should really be documented
pub fn start_apocalypse(u: &mut Universe) {
unimplemented!();
}
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
unnecessary_safety_doc = "warn"In code
#![warn(clippy::unnecessary_safety_doc)]One run
cargo clippy -- -W clippy::unnecessary-safety-docThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Settings in clippy.toml
check-private-items: Whether to also run the listed lints on private items.
Clippy's own documentation
What it does
Checks for the doc comments of publicly visible
safe functions and traits and warns if there is a # Safety section.
Why restrict this?
Safe functions and traits are safe to implement and therefore do not need to describe safety preconditions that users are required to uphold.
Examples
/// # Safety
///
/// This function should not be called before the horsemen are ready.
pub fn start_apocalypse_but_safely(u: &mut Universe) {
unimplemented!();
}
The function is safe, so there shouldn’t be any preconditions that have to be explained for safety reasons.
/// This function should really be documented
pub fn start_apocalypse(u: &mut Universe) {
unimplemented!();
}
Configuration
-
check-private-items: Whether to also run the listed lints on private items.(default:
false)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on Options
- module_name_repetitionsDetects public item names that are prefixed or suffixed by the containing public module’s name
- expect_usedChecks for .expect() or .expect_err() calls on Results and .expect() call on Options
- unimplemented`unimplemented` should not be present in production code
- unnecessary_rest_patternunnecessary rest pattern (`..`)
- unnecessary_safety_commentstatement has unnecessary safety comment
- unnecessary_self_importsimport ending with `::{self}`
- unneeded_field_patternyou matched a field with a wildcard pattern, consider using `..` instead
- unreachableusage of the `unreachable!` macro
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on OptionsRead it next →Did this answer your question?