rust-lang / rust-lang/rust-clippy
Lint to detect unneeded `// ORDERING: ...` comments
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
The dual lint to the one(s) that require those comments: https://github.com/rust-lang/rust-clippy/issues/16073.
In other words, like unnecessary_safety_comment, but for // ORDERING: ... comments.
Cc: @blyxyas @hcbarker @fbq
Advantage
No response
Drawbacks
No response
Example
// ORDERING: ...
f();
Should be written as:
f();
Comparison with existing lints
No response
Additional Context
For details and context, please see the dual lint linked above.
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
Read the linked dual issue, rust-lang/rust-clippy#16073, first to understand how the corresponding required-comment lint is specified and organized. Then locate the existing unnecessary_safety_comment lint and its tests; done should include coverage for an unnecessary // ORDERING: ... comment before f(); and confirm the lint reports it.
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
- 42/100