[facet.num.get.virtuals]p3 needs rework
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
[facet.num.get.virtuals]p3 is a very long paragraph (nearly a page and a half), nearly all of which is indented two or three levels. It contains quite a few (un-numbered) paragraph breaks within "stages". We should investigate more conventional ways to present this process.
Similarly for [facet.num.put.virtuals]p4, which is presented as one big "Returns:" clause, although it very much is not.
Contributor guide
No contributing guide indexed for this repository
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 [facet.num.get.virtuals]p3 and [facet.num.put.virtuals]p4 entries in the TeX sources and reviewing how their stages and return information are currently presented. Compare those structures with more conventional presentations elsewhere in the draft; the work is done when both entries no longer use the described oversized paragraph or single Returns clause.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100