rust-lang / rust-lang/reference
Document which attributes are allowed in places they have no effect
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
There are various attributes that are allowed in places where they have no effect. For example, you can use #[inline] on fields of a struct. For the ones the lang team has decided they cannot prohibit due to code breakage, we must document that they are allowed.
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
The issue names no files, tests, or complete list of attributes to document. Start by reviewing the Rust Reference's attribute documentation and the lang team's decisions about attributes that cannot be prohibited. Done means documenting each permitted no-effect attribute and where it is allowed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100