mirror/postgresql
2
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2025-01-18 18:44:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add "May/Can/Might" section to error message style guidlines, and

Browse Source 
"can't" -> "cannot" section.
This commit is contained in:
Bruce Momjian 2007-02-01 21:28:34 +00:00
parent 2576dd4dee
commit f7e5ecb026
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/src/sgml/sources.sgml
View File

@ -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>