From ee37fb57c02afcfe6b2b2c75b39aeb86c28f7ac8 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut <peter_e@gmx.net> Date: Mon, 28 Jun 2010 17:48:26 +0000 Subject: [PATCH] Add guidelines for formatting errcontext strings --- doc/src/sgml/sources.sgml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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> @@ -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 -- GitLab