This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Patch to document policy on e.g./i.e. and commas
- To: <gcc-patches at gcc dot gnu dot org>
- Subject: Patch to document policy on e.g./i.e. and commas
- From: "Joseph S. Myers" <jsm28 at cam dot ac dot uk>
- Date: Sun, 11 Nov 2001 20:30:03 +0000 (GMT)
This patch documents a policy of using commas after "e.g." and "i.e." only
when appropriate. (This means that there is no need to go through the
manuals making bulk changes in either direction, though there may be some
cases where a different form would be clearer than the one currently
there.) OK to commit?
Index: codingconventions.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/codingconventions.html,v
retrieving revision 1.9
diff -u -r1.9 codingconventions.html
--- codingconventions.html 2001/11/07 14:56:42 1.9
+++ codingconventions.html 2001/11/11 20:26:29
@@ -248,6 +248,12 @@
compilation when the emphasis is on those; "GNU C" and "GNU C++" for
language dialects; and try to avoid the older term "GNU CC".</p>
+<p>Use a comma after "e.g." or "i.e." if and only if it is appropriate
+in the context and the slight pause a comma means helps the reader; do
+not add them automatically in all cases just because some style guides
+say so. (In Texinfo manuals, <code>@:</code> should to be used after
+"e.g." and "i.e." when a comma isn't used.)</p>
+
<p>In Texinfo manuals, Texinfo 4.0 features may be used, and should be
used where appropriate. URLs should be marked up with
<code>@uref</code>; email addresses with <code>@email</code>;
--
Joseph S. Myers
jsm28@cam.ac.uk