diff options
| author | Bruce Momjian <bruce@momjian.us> | 2007-02-01 21:28:34 +0000 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2007-02-01 21:28:34 +0000 |
| commit | f7e5ecb02645f8c7627e5837e9828a388626b74e (patch) | |
| tree | e59678b6257ec497b795ca18b8cbfeeb31dcb00a | |
| parent | 2576dd4deecc4fd1954b62a1530c9049965f6be9 (diff) | |
| download | postgresql-f7e5ecb02645f8c7627e5837e9828a388626b74e.tar.gz postgresql-f7e5ecb02645f8c7627e5837e9828a388626b74e.zip | |
Add "May/Can/Might" section to error message style guidlines, and
"can't" -> "cannot" section.
| -rw-r--r-- | doc/src/sgml/sources.sgml | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index c9cbd68d42f..a3c989b6fb6 100644 --- a/doc/src/sgml/sources.sgml +++ b/doc/src/sgml/sources.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.25 2007/02/01 20:28:08 tgl Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.26 2007/02/01 21:28:34 momjian Exp $ --> <chapter id="source"> <title>PostgreSQL Coding Conventions</title> @@ -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> |