Confusion about formatting of Cpp17 iterator requirements
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
I'm confused about how iterator requirements should be formatted.
[forward.iterators] uses no formatting at all, and says
meets the requirements of a forward iterator if
However, it simultaneously references Cpp17InputIterator which is not consistent.
[iterator.requirements.general] p14 references "non-forward iterator", but this is not a defined term because "forward iterator" isn't defined, and it also doesn't use Cpp17ForwardIterator formatting.
Overall, this is very confusing, and I don't understand the logic behind when ItalicRequirement formatting should be used, and when plain formatting, or definition formatting should be used.
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 reviewing the linked [[forward.iterators]] section and [[iterator.requirements.general]] paragraph 14. Compare how Cpp17InputIterator, Cpp17ForwardIterator, and the plain terms are formatted, then document or apply a consistent rule for these references. Done means the formatting convention and its application are clear and consistent in the cited passages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100