From: Peter Eisentraut <peter_e@gmx.net>
Date: Mon, 28 Jun 2010 17:48:26 +0000 (+0000)
Subject: Add guidelines for formatting errcontext strings
X-Git-Tag: REL9_0_BETA3~65
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ee37fb57c02afcfe6b2b2c75b39aeb86c28f7ac8;p=postgresql

Add guidelines for formatting errcontext strings
---

diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 342f8e4ef7..ec33170f69 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>
@@ -444,6 +444,12 @@ Hint:       the addendum
     inappropriate in other languages).
    </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