diff options
| author | Peter Eisentraut <peter_e@gmx.net> | 2010-06-28 17:48:26 +0000 |
|---|---|---|
| committer | Peter Eisentraut <peter_e@gmx.net> | 2010-06-28 17:48:26 +0000 |
| commit | ee37fb57c02afcfe6b2b2c75b39aeb86c28f7ac8 (patch) | |
| tree | 9c4d91cbea313dd9f6077cba4192a59184c9f853 | |
| parent | 7bfc0e5e79f2ab280b58f1f53e5115e70548f6fc (diff) | |
| download | postgresql-ee37fb57c02afcfe6b2b2c75b39aeb86c28f7ac8.tar.gz postgresql-ee37fb57c02afcfe6b2b2c75b39aeb86c28f7ac8.zip | |
Add guidelines for formatting errcontext strings
| -rw-r--r-- | doc/src/sgml/sources.sgml | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index 342f8e4ef73..ec33170f691 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.35 2009/10/08 02:39:16 tgl Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.36 2010/06/28 17:48:26 petere Exp $ --> <chapter id="source"> <title>PostgreSQL Coding Conventions</title> @@ -445,6 +445,12 @@ Hint: the addendum </para> <para> + Error context strings: Do not capitalize the first letter and do + not end the string with a period. Context strings should normally + not be complete sentences. + </para> + + <para> Rationale: Avoiding punctuation makes it easier for client applications to embed the message into a variety of grammatical contexts. Often, primary messages are not grammatically complete sentences anyway. (And if they're |