Add documtation for the rustfmt::skip attribute
Open
Nobody has claimed this yet.
A-config
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Documentation for the #[rustfmt::skip] attribute does not exist. The #[rustfmt::skip::macros(target_macro_name)] and #[rustfmt::skip::attributes(target_attribute_name)] variants are only mentioned in the README and it is unclear if there are more.
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 rustfmt documentation linked in the issue and compare it with the README sections mentioning #[rustfmt::skip::macros(...)] and #[rustfmt::skip::attributes(...)]. Identify the supported rustfmt::skip forms and document them consistently. Done means the documentation clearly explains the attribute and its variants, including whether additional forms exist.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100