Add supporting documentation for Macros
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 18.3k
- Forks
- 4.1k
- Avg merge
- 14m
- Merged PRs (30d)
- 1
Description
- I have checked the latest
mainbranch to see if this has already been fixed - I have searched existing issues and pull requests for duplicates
URL to the section(s) of the book with this problem:
https://doc.rust-lang.org/book/ch19-06-macros.html
Description of the problem:
Macros have always been underdocumented in the book which is outstanding otherwise. While Macros may be too much to cover all at once in the book I think further docmentation should be referenced.
Suggested fix:
Add an appendix with
https://github.com/dtolnay/proc-macro-workshop
and
https://danielkeep.github.io/tlborm/book/README.html
referenced for further reading to prevent sending programmers on a search campaign for more information.
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 Macros section at https://doc.rust-lang.org/book/ch19-06-macros.html and review the proposed proc-macro-workshop and The Little Book of Rust Macros resources. Done means the book includes an appendix or further-reading section linking to both resources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100