From 909355851bfb21086422e6edc0b2b75fbaa58418 Mon Sep 17 00:00:00 2001 From: Alvaro Herrera Date: Tue, 7 Nov 2023 10:24:00 +0100 Subject: [PATCH] Message style: Add paragraph about quoting names --- doc/src/sgml/sources.sgml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index 06d995e4b7..d72e114ea3 100644 --- a/doc/src/sgml/sources.sgml +++ b/doc/src/sgml/sources.sgml @@ -532,23 +532,31 @@ Hint: The addendum, written as a complete sentence. Use of Quotes Always use quotes to delimit file names, user-supplied identifiers, and other variables that might contain words. Do not use them to mark up variables that will not contain words (for example, operator names). There are functions in the backend that will double-quote their own output as needed (for example, format_type_be()). Do not put additional quotes around the output of such functions. + + In messages containing configuration variable names, quotes are + not necessary when the names are visibly not English natural words, such + as when they have underscores or are all-uppercase. Otherwise, quotes + must be added. Do include double-quotes in a message where an arbitrary + variable name is to be expanded. + + Rationale: Objects can have names that create ambiguity when embedded in a message. Be consistent about denoting where a plugged-in name starts and ends. But don't clutter messages with unnecessary or duplicate quote marks. -- 2.39.2