Clippy · Maintainability
Public unsafe fn without a Safety section
clippy::missing_safety_doc
Document in a `# Safety` section the invariants the caller must uphold before calling.
- Category
- Maintainability
- Default level
- warn
- Tier
- P3
- Producer
- Clippy
- Diff scope
- line
Not a defect when
The function is doc(hidden) and exported only for the crate's own macros, and its safety contract is documented on the macro that emits the call.
What it reads
Clippy, with the compiler behind it. The only pass that compiles.
Tier
Lowest tier: real, and rarely urgent.
The tier bounds how severe a rule may be; its category bounds the tier.Diff scope
The changed line itself.
What--scope contextual looks at to decide whether a change caused the finding.Change it
Turn it off, or make it blocking, without touching the code it flags:
rust-doctor --rule clippy::missing_safety_doc=off .
rust-doctor --rule clippy::missing_safety_doc=error .