Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

STL: Update comments citing old Working Papers #182

Open
StephanTLavavej opened this issue Oct 18, 2019 · 3 comments
Open

STL: Update comments citing old Working Papers #182

StephanTLavavej opened this issue Oct 18, 2019 · 3 comments
Labels
documentation Related to documentation or comments

Comments

@StephanTLavavej
Copy link
Member

StephanTLavavej commented Oct 18, 2019 •
edited
Loading

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:

  1. Citing the now-current Working Paper
  2. Dropping the section number
  3. Checking that the stable name is still accurate (these rarely change, but it happens)
  4. Updating the paragraph numbers if they have changed
  5. Updating any quoted wording (making sure to clean out non-ASCII characters like long dashes)
@StephanTLavavej StephanTLavavej added documentation Related to documentation or comments enhancement Something can be improved labels Oct 18, 2019
@StephanTLavavej StephanTLavavej mentioned this issue Oct 23, 2019
Merged
5 tasks
@CaseyCarter
Copy link
Member

All of our working draft citations will always be either out-of-date or at most a few months away from being out-of-date: the working drafts are a clock that never stops ticking. Given that we can't stay current without someone committing to updating every citation every time WG21 publishes a new working draft - which seems like effort that could be better invested elsewhere - I assume your intent is that we update all citations to working drafts older than X? Or perhaps that we update all citations to the final pre-publication working draft every time WG21 publishes a standard? (Once every three years seems more reasonable than once every four months.)

@StephanTLavavej
Copy link
Member Author

StephanTLavavej commented Oct 23, 2019 •
edited
Loading

Yeah, I think a global pass to update to the latest WP at the time, and then to each Standard, is a reasonable concrete goal.

@StephanTLavavej StephanTLavavej mentioned this issue Jan 31, 2020
Closed
@BillyONeal

This comment was marked as outdated.

Sign in to view
@StephanTLavavej StephanTLavavej removed the enhancement Something can be improved label Feb 6, 2020
@StephanTLavavej StephanTLavavej mentioned this issue Mar 24, 2021
Merged
@StephanTLavavej StephanTLavavej mentioned this issue Sep 8, 2022
Merged
@StephanTLavavej StephanTLavavej mentioned this issue Oct 12, 2022
Merged
@frederick-vs-ja frederick-vs-ja mentioned this issue Oct 18, 2022
Closed
@frederick-vs-ja frederick-vs-ja mentioned this issue Dec 12, 2022
Merged
@frederick-vs-ja frederick-vs-ja mentioned this issue Feb 28, 2023
Merged
@frederick-vs-ja frederick-vs-ja mentioned this issue May 9, 2023
Merged
CaseyCarter added a commit that referenced this issue May 18, 2023
@frederick-vs-ja @StephanTLavavej
@strega-nil @CaseyCarter
Cite N4950 in headers and source files (#3686)
d3a7da7 
Towards #182.

- This PR drops all section numbers except for D.x in `<yvals_core.h>`. I decided to cite WG21-N4868 for C++20 deprecation.
- Some citations in `<format>` are intentionally not updated because WG21-P2675R1 and LWG-3631 are not implemented yet.
- Citations in test files are not updated, but I think I'll do it soon.
- Drive-by change: a comment for `move_only_function`'s move assignment operator explaining why it's `noexcept(false)` (see #3565 (comment) and #2278 (comment)).

---------

Co-authored-by: Stephan T. Lavavej <stl@nuwen.net>
Co-authored-by: Nicole Mazzuca <mazzucan@outlook.com>
Co-authored-by: Casey Carter <cacarter@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Related to documentation or comments
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@CaseyCarter @BillyONeal @StephanTLavavej