rustdoc: Various `#[doc]` attributes are not fully validated (e.g., `#[doc(hidden)]`, `#[doc(no_inline)]`)
Open
Nobody has claimed this yet.
A-attributes
C-bug
T-compiler
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
The docs don't mention this. Is it supposed to represent the reason why the item is hidden, or was it an oversight?
12 instances of this on GitHub: https://github.com/search?q=%2F%23%5C%5Bdoc%5C(hidden%20%3D%20%22%2F&type=code
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
Begin with the rustdoc documentation for the #[doc] attribute, especially the hidden section, and review the 12 existing GitHub uses linked in the issue. Determine which forms are intended to be validated and documented; done means the validation behavior and documentation clearly agree for cases such as #[doc(hidden)] and #[doc(no_inline)].
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100