Desugaring doc comments
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
#270 added descriptions of the process of desugaring doc comments to doc attributes to chapter 2 (lexical elements), defining the notion of an equivalent attribute doc, and to various places in chapter 20 (Macros), using that notion.
The descriptions in chapter 2 describe this process for both inner and outer doc comments, but the descriptions in chapter 20 describe it only for outer doc comments. I think the descriptions in chapter 20 should say it applies to inner doc comments too.
Those descriptions are in:
- §20.4:3 (
fls_40xq8Ri1OMZZ) - §20.4:13 (
fls_nNrs4EC3ff5T) - §20.4:23 (
fls_vqIZaEl4EKu5) - §20.4:29 (
fls_AJmPrhHfZo6J)
(Also there's a typo "amd" for "and" in §2.5:16, fls_ok0zvo9vcmzo.)
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
Review the desugaring descriptions in chapter 20 at §20.4:3, §20.4:13, §20.4:23, and §20.4:29, then compare them with the chapter 2 descriptions of inner and outer doc comments. Update the chapter 20 wording to cover both kinds and correct "amd" to "and" in §2.5:16.
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
- 55/100