[std] Punctuation after "OK" example comments
Open
Nobody has claimed this yet.
big
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
I thought the policy for example comments "// OK, explanation" was to use a comma. However, the statistics are not in my favor:
$ grep "// OK," *.tex | wc -l
138
$ grep "// OK:" *.tex | wc -l
251
Asking for confirmation of the policy before providing a large-scale fix.
Incidentally related to #3126.
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 policy question in this issue and the related discussion in #3126, then rerun the provided grep commands over the *.tex files. Once the punctuation policy is confirmed, update the affected example comments consistently and verify that the counts reflect the agreed convention.
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
- Mostly clear
- Newbie friendliness
- 35/100