rust-lang / rust-lang/rust-clippy
Lint unnecessary doc(hidden) attribute
Open
Nobody has claimed this yet.
A-lint
E-medium
T-AST
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Lint against marking things that wouldn't show up in the documentation anyway doc(hidden).
Examples are:
-
Private items.
#[doc(hidden)] fn foo() { } -
Implementing private traits (example lifted from rust-sfml)
// Wrappable is a private trait that doesn't show up in documentation, // so neither will implementations. #[doc(hidden)] impl Wrappable<*mut ffi::sfConvexShape> for ConvexShape { #[doc(hidden)] fn wrap(convex_shape: *mut ffi::sfConvexShape) -> ConvexShape { ConvexShape { convex_shape: convex_shape.clone(), texture: None } } #[doc(hidden)] fn unwrap(&self) -> *mut ffi::sfConvexShape { self.convex_shape } }
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 with the Rust examples in the issue and inspect existing rust-clippy lint entry points for documentation attributes. The lint is done when it reports unnecessary doc(hidden) attributes on private items and implementations of private traits, with tests covering both examples.
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