rust-lang / rust-lang/reference
rename "Macros By Example" section to "Declarative Macros"
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
this terminology is rarely used outside of the reference, and is fairly confusing. it is especially easy to confuse this page for the rust by example page on macros.
proposed changes:
- change https://doc.rust-lang.org/reference/macros-by-example.html to https://doc.rust-lang.org/reference/declarative-macros.html
- add a redirect from the old url to the new url
- change the page title to "Declarative Macros"
- add "sometimes called Macros By Example" to the page body.
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 by locating the Rust Reference page at macros-by-example.html and inspect how its URL and redirects are configured. Rename the page to declarative-macros.html, update the title and body terminology, add the redirect from the old URL, and verify that both URLs resolve as intended.
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
- Clearly specified
- Newbie friendliness
- 65/100