Consistent comma after e.g. and i.e. #1512
Conversation
After grepping to determine the preferred idiom, it seems clear that the standard prefers to follow both e.g. and i.e. with a comma, rather than omit it. This patch applies that rule to the few places that were missing the comma, including in LaTeX comments only for the editors' benefit.
jensmaurer
added
the
decision-required
| @@ -2257,7 +2257,7 @@ | |||
| \end{example} | |||
|
|
|||
| \begin{example} | |||
| One can make a class uncopyable, i.e. move-only, by using deleted | |||
| One can make a class uncopyable, i.e., move-only, by using deleted | |||
There was a problem hiding this comment.
This seems like abuse of "i.e." -- uncopyable and move-only are not equivalent. More drastic rewording seems necessary here.
| @@ -4057,7 +4057,7 @@ | |||
| \pnum | |||
| \returns \tcode{true} if | |||
| \range{first}{last} is empty or if | |||
| \range{first}{last} is partitioned by \tcode{pred}, i.e. if all elements that satisfy \tcode{pred} appear before those that do not. | |||
| \range{first}{last} is partitioned by \tcode{pred}, i.e., if all elements that satisfy \tcode{pred} appear before those that do not. | |||
There was a problem hiding this comment.
More damage to the English language perpretrated by Strunk and White, but OK, this is the dominant American English style, so let's put up with it.
There was a problem hiding this comment.
Personally, I believe the "comma after i.e." thing is totally misguided. Nobody knows what "i.e." and "e.g." means in the expanded form, plus it's Latin anyway, so the argument "oh, it's a complete sentence lookalike, so should have commas around it" is broken. (Have you ever seen the expanded form in English?). We don't put a comma after "but" or "where" either.
| @@ -147,7 +147,7 @@ | |||
| An \defn{execution agent} is an entity such as a thread that may perform work in parallel with | |||
| other execution agents. \begin{note} Implementations or users may introduce other kinds of | |||
| agents such as processes or thread-pool tasks. \end{note} The calling agent is determined by | |||
| context, e.g. the calling thread that contains the call, and so on. | |||
| context, e.g., the calling thread that contains the call, and so on. | |||
There was a problem hiding this comment.
I do not think we need both an 'e.g.' and an 'and so on' here.
There was a problem hiding this comment.
I actually think the entire "e.g." part needs a more drastic rewrite. This just doesn't read well.
And what "call" are we talking about? A "function call" in the syntactic sense of [expr.call]?
Suggestion: "is determined by the context, such as the thread of execution that contains the invocation of the function." (This is consistent with [intro.multithread] p2.)
Oh, and does this note attempt to define the term "calling agent"? Then it would be totally misguided.
|
One argument why we want a comma after e.g. and i.e.: LaTeX gets the spacing wrong otherwise. |
|
@jensmaurer that issue should instead be fixed by either using an appropriate dictionary or by escaping the space, i.e. |
|
Editorial meeting consensus: Add definition of "partitioned by" and actually use that in all seven situations. Review all uses of "i.e.": if you specify a rule twice, at least one of them is wrong. Remove them. "e.g." should not be written in normative text, attempt to replace with "for example". Should only be used in notes. Also consider "[ Example ... ]" if containing at least a full sentence. |
jensmaurer
removed
the
decision-required
|
I can take this over. I'll probably create several commits for the various separate issues here. Leave it with me. |
tkoeppe
added
the
needs rebase
|
Stolen and committed (finally) as deb9fb1. |
After grepping to determine the preferred idiom, it seems clear that
the standard prefers to follow both e.g. and i.e. with a comma, rather
than omit it. This patch applies that rule to the few places that
were missing the comma, including in LaTeX comments only for the editors'
benefit.