STL: Update comments citing old Working Papers
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 1.7k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 22
Description
In comments, we often cite and quote the current Working Paper. Over the years, its sections are renumbered and its wording changes due to features being added, library issues being resolved, and editorial issues being cleaned up. This is especially true after a recent overhaul of Constraints/Mandates/Requires/etc. elements.
We should clean up these old comments (and static_assert messages), which involves:
- Citing the now-current Working Paper
- Dropping the section number
- See https://github.com/microsoft/STL/pull/3101#issuecomment-1274034226 for rationale - section numbers are basically noise, they change too frequently, and searching for
[stable.name]is fast
- See https://github.com/microsoft/STL/pull/3101#issuecomment-1274034226 for rationale - section numbers are basically noise, they change too frequently, and searching for
- Checking that the stable name is still accurate (these rarely change, but it happens)
- Updating the paragraph numbers if they have changed
- Updating any quoted wording (making sure to clean out non-ASCII characters like long dashes)
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
Search the repository for comments and static_assert messages that cite the Working Paper, then compare each citation and quotation with the current Working Paper. Done means outdated section numbers are removed, stable names and paragraph numbers are verified, wording is current, and non-ASCII characters are cleaned up.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100