summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Momjian2007-02-01 21:28:34 +0000
committerBruce Momjian2007-02-01 21:28:34 +0000
commit011f2de47b70b74e84db070d17b5ed8c04c2a466 (patch)
treee8fdc4a3b519a3e43f5880f38f4617ce0ad6ad40
parent319dac5f58b6c65119efaf0f7f0ee60502d5518f (diff)
Add "May/Can/Might" section to error message style guidlines, and
"can't" -> "cannot" section.
-rw-r--r--doc/src/sgml/sources.sgml24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 0aae3751c1..718681a521 100644
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -605,6 +605,30 @@ BETTER: unrecognized node type: 42
</para>
</formalpara>
+ <formalpara>
+ <title>May/Can/Might</title>
+ <para>
+ <quote>May</quote> suggests permission (e.g. "You may borrow my rake.")
+ and has little use in documentation or error messages.
+ <quote>Can</quote> suggests ability (e.g. "I can lift that log."),
+ and <quote>might</quote> suggests possibility (e.g. "It might rain
+ today.").
+ </para>
+
+ <para>
+ Rationale: Using the proper word clarifies meaning and assists
+ translation.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Contractions</title>
+ <para>
+ Avoid contractions, like <quote>can't</quote>; use
+ <quote>cannot</quote> instead.
+ </para>
+ </formalpara>
+
</simplesect>
<simplesect>