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.

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

Process: page-by-page review tracking #4228

Closed
tkoeppe opened this issue Sep 23, 2020 · 10 comments
Closed

Process: page-by-page review tracking #4228

tkoeppe opened this issue Sep 23, 2020 · 10 comments
Milestone

Comments

@tkoeppe
Copy link
Contributor

tkoeppe commented Sep 23, 2020

See #4219 for detailed instructions.

Please edit this comment to claim a section of the document.
DP: See comment for questions about the sections I reviewed.

  • {TK: good} Front matter + Clauses 1, 2, 3
  • {TK: done} 4 General principles[intro]
  • {TK: done} 5 Lexical conventions[lex]
  • {TK: done} 6 Basics[basic]
  • {DP: done} 7 Expressions[expr]
  • {DP: done} 8 Statements[stmt.stmt]
  • {DP: done} 9 Declarations[dcl.dcl]
  • {DP: good} 10 Modules[module]
  • {DP: done} 11 Classes[class]
  • {DP: done} 12 Overloading[over]
  • {DP: done, see note in comment below} 13 Templates[temp]
  • {DP: good} 14 Exception handling[except]
  • {DP: good} 15 Preprocessing directives[cpp]
  • {DP: done} 16 Library introduction[library]
  • {DP: done} 17 Language support library[support]
  • {DP: done} 18 Concepts library[concepts]
  • {DP: good} 19 Diagnostics library[diagnostics]
  • {DP: done} 20 General utilities library[utilities]
  • {DP: done} 21 Strings library[strings]
  • {DP: done} 22 Containers library[containers]
  • {TK: done} 23 Iterators library[iterators]
  • {TK: done} 24 Ranges library[ranges]
  • (JM: done) 25 Algorithms library[algorithms]
  • (JM: good) 26 Numerics library[numerics]
  • (JM: done; still done after "tailnote") 27 Time library[time]
  • (JM: done) 28 Localization library[localization]
  • (JM: re-done after [std] Introduce tailnote environment to avoid empty lines in tables. #4249) 29 Input/output library[input.output]
  • (JM: done) 30 Regular expressions library[re]
  • (JM: done) 31 Atomic operations library[atomics]
  • {JM: done please revisit still done} 32 Thread support library[thread]
  • {TK: done} Annex A (informative) Grammar summary[gram]
  • {TK: good} Annex B (informative normative) Implementation quantities[implimits]
  • {TK: done} Annex C (informative) Compatibility[diff]
  • {TK: done} Annex D (normative) Compatibility features
  • {TK: done} Back matter

Key:

  • "good": Good as is, no changes needed.
  • "done": Good after review, but changes need to be applied (and are ready to be merged).
  • anything else: still needs attention
@tkoeppe tkoeppe added this to the C++20 milestone Sep 23, 2020
@tkoeppe
Copy link
Contributor Author

tkoeppe commented Sep 23, 2020

Please reference this isse (#4228) in pull requests (onto the c++20 branch) for one-off tweaks, or for pull reqests onto master for permanent changes.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Sep 24, 2020

Merging notes: The following changes should be made to the main branch and need to be cherrypicked.

All done here.

burblebee pushed a commit that referenced this issue Sep 26, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 26, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 26, 2020
@burblebee
Copy link
Contributor

burblebee commented Sep 26, 2020

See branch c++20_tweaks for changes to the sections I reviewed. See below for notes/comments.

Cases where a section is near the end of a page - which of these should be fixed?

  • [string.view.synop] 21.4.2 pg.790
  • [cstring.syn] 21.5.3 pg.800
  • Note: [stmt.ambig] Adding page break here caused "-end example]" to spill to next page, so not done.

Not addressed:

  • 13.7.3p1 Example 2 [temp.mem] Lonely "-end example]"; if fixed, causes several other examples to spill over. Left as is.
  • 13.10.3.1p11.10 [temp.deduct.general] Lonely "-end note]"; no objections to leaving as is in IRC chat.

Issues discovered during review (not fixed):

  • 16.4.4.2 [tab:cpp17.equalitycomparable], Extra blank line after itemized list in library table.
  • 16.4.4.3p2 [swappable.requirements] pg.488,
    Start of paragraph followed by several tables before rest of paragraph.
  • 22.2.6.1 [tab:container.assoc.req] pg.821,
    "a.emplace_hint(p, args)" Missing \effects?
  • We have issues under https://github.com/cplusplus/issues/issues, oops?
  • 22.2.7.1 [tab:container.hash.req] Table 81 pg.836,
    3 cases missing \br before next itemdecl clause
    in containers.tex around lines 2790, 2883, 2931.
    Check all "Assertion/note"s in tables for more cases.
  • 9.3.4.6p18 [dcl.fct], Change "These declarations" to "The declarations above" so it's clear which declarations we're talkinng about.
  • 13.7.3p1 Example 2 [temp.mem], Join "}" with previous "{" for consistency.
  • 20.15.8.7p4-p7 pg.729 [meta.trans.ptr], Why are we calling these "Note"s when this is normative wording?
  • [module.interface]p7 Rename "rootFinder" in example to something more Core friendly.

Changes which should be merged to master:

  • 7130f45 [tab:meta.trans.other] Remove blank line before Preconditions.
  • 4bc3589 [tab:container.hash.req] Add a line break before next itemdecl clause.
  • 4d1baf4 [expr.const] Replace notes in sentences with footnotes.

(answered below) Why do we sometimes start a section with "Preamble" vs. "General"? I know the "General" sections were added in response to IS, but many seem to contain the same sort of information as the "Preamble"s.

@jensmaurer
Copy link
Member

"Preamble" was our earlier incomplete attempt at avoiding "hanging paragraphs". I'm sure we'll address some of the recently added "General" paragraphs for C++20 and maybe rename them or dissolve them.

burblebee pushed a commit that referenced this issue Sep 26, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 27, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
Partially addresses #4228.
burblebee pushed a commit that referenced this issue Sep 30, 2020
@zygoloid
Copy link
Member

zygoloid commented Oct 2, 2020

All merged.

@zygoloid zygoloid closed this as completed Oct 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants