[iterator.synopsis] The <iterator> header should be // mostly freestanding

Open Beginner friendly
#8,545 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, tex
Domain
documentation

Research direction

Find the synopsis in the draft source and review its freestanding annotations, with issue #8544 in mind for nearby line breaks. Remove redundant annotations, mark the stream iterators as hosted where appropriate, and confirm the synopsis formatting remains correct.

Written by the indexing model from the issue text.

Description

P3-Other

Just about every declaration in the synopsis for <iterator> is marked as // freestanding. The only exceptions are the stream iterators that could be marked as // hosted instead.

Removing many // freestanding comments might also help with the linebreaks in this header, especially after applying #8544.

Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cplusplus/draft

All issues in cplusplus/draft

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.