rust-lang / rust-lang/rust-clippy
Unsafe attributes support (`undocumented_unsafe_blocks`)
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
What it does
Unsafe attributes have been stabilized (https://github.com/rust-lang/rust/pull/128771, https://github.com/rust-lang/rust/issues/123757), thus it would be nice to have a lint that ensures // SAFETY comments are in place.
Since undocumented_unsafe_blocks covers impls too, perhaps it should also cover this too, although it may be best to possibly split them (but that is a different issue).
See https://github.com/rust-lang/rust-clippy/issues/13317 as well.
Advantage
No response
Drawbacks
No response
Example
#[unsafe(no_mangle)]
pub fn f() {}
Should be written as:
// SAFETY: ...
#[unsafe(no_mangle)]
pub fn f() {}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the Rust stabilization PR and issue linked in the description, then compare the related rust-lang/rust-clippy issue 13317. Define the lint's scope, including whether it covers impls, and verify that the unsafe attribute example requires a preceding SAFETY comment.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100