← Rule catalog

Clippy · Maintainability

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

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.

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 .

Set it once in rust-doctor.toml

Upstream

Clippy's own documentation for this lint

Other Maintainability rules