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

Many fixes in [diff] #214

Closed
sdutoit opened this issue Oct 13, 2013 · 1 comment
Closed

Many fixes in [diff] #214

sdutoit opened this issue Oct 13, 2013 · 1 comment

Comments

@sdutoit
Copy link
Contributor

sdutoit commented Oct 13, 2013

From an email to cxxeditor@ from Guilliam Xavier:

Hello Mr. Du Toit,

While reading Annex C (informative) Compatibility [diff] in N3690, I noticed some typos and other problems. One of them has been recently fixed in the Git repository (wrong C headers count) but there are more. I don't have a GitHub account for now so here's an email.

First, I am attaching some editorial fixes. The modifications are all located in the source file "compatibility.tex" (current version, last change to the file on GitHub draft repository was commit a7e0895 "[diff.mods.to.headers] Remove redundant (and wrong) count of C headers." of Sep 26, 2013).
#1.diff

Editorial fixes that I think should be applied.

  • [diff.basic] [diff.expr] [diff.dcl] Add an effective line break (4 locations).
  • [diff.basic] Delete spurious \rationale macro in \difficulty text.
  • [diff.basic] Insert missing space between words.
  • [diff.basic] [diff.cpp03.conv] Add a final period for consistency (5 locations).
  • [diff.expr] Remove "a" article for consistency.
  • [diff.dcl] [diff.class] Replace "C++" with the \Cpp macro (2 locations).
  • [diff.class] Fix typo "choise" -> "choice".
  • [diff.class] Replace "Change of semantics of" with "Change to semantics of" for consistency.
  • [diff.special] Make example really "valid in ISO C" by using copy-initialization syntax.
  • [diff.cpp03.lex] Fix typo "tokens" -> "token" ("a single preprocessing token").
  • [diff.cpp03.library] Fix typo "in This" -> "in this" (lowercase T).
  • [diff.cpp03.containers] Fix wrong macro use \effects -> \effect.
    Make the standard build on OS X with macports sed. #2.diff

Editorial fixes that I am less sure about.

  • [diff.basic] Format "Main" in code font ("main").
  • [diff.expr] Remove extra space before period.
  • [diff.dcl] Format "const" in code font.

(For that last one, an alternative would be to capitalize "const" to "Const".)
#3.diff

Editorial fix for consistency. Among the 67 "Change:" headings, 58 don't end the first line with a period, but 9 do; that feels somewhat inconsistent. As for whether add 58 periods or remove 9, the second alternative is a smaller change.

  • [diff.dcl] [diff.decl] [diff.class] [diff.cpp03.special] [diff.cpp11.dcl.dcl] Remove final period for consistency (9 locations).

Note: when trying to apply the patches, I saw that 2.diff can only be applied after 1.diff has been applied.

Feel free to tweak the modifications.

Additionally, in [diff.library], paragraph 4 reads "The C++ standard library provides 57 standard values from the C library, as shown in Table 150." but Table 150 shows 45 values, not 57 (Table 149 does show 57 standard macros, so that looks like a problem of copy-paste from paragraph 2).
But that's not all to it, because the tables in this section (Tables 149 to 153) seem to be incomplete: Table 149 is missing e.g. HUGE_VALF from Table 119 [c.math], Table 150 is missing e.g. LLONG_MIN from Table 31 and DECIMAL_DIG from Table 32 [c.limits], Table 153 is missing e.g. strtoll from Table 78 [c.strings]... (sorry, I don't know how to make a list that we could be confident is complete, so I just picked one random instance in some tables).

I would be pleased if you can give me some feedback.

Thank you. Best regards

@sdutoit
Copy link
Contributor Author

sdutoit commented Oct 13, 2013

Diffs provided by Guilliam here:
https://gist.github.com/sdutoit/6964872 ("1.diff")
https://gist.github.com/sdutoit/6964876 ("2.diff")
https://gist.github.com/sdutoit/6964883 ("3.diff")

jensmaurer added a commit to jensmaurer/draft that referenced this issue Nov 23, 2016
Consistently end the 'Changes' phrase with a period.
Add missing newlines.
Remove spurious 'Rationale' item.
Fix typos.

Fixes cplusplus#214.
tkoeppe pushed a commit that referenced this issue Nov 26, 2016
Consistently end the 'Changes' phrase with a period.
Add missing newlines.
Remove spurious 'Rationale' item.
Fix typos.

Fixes #214.
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

1 participant