public inbox for [email protected]  

help / color / mirror / Atom feed

From: Bruce Momjian <[email protected]>
To: [email protected]
To: [email protected]
Subject: Re: Unclear Wording
Date: Tue, 7 Jun 2022 20:15:18 -0400
Message-ID: <Yp/[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>

On Mon, Jun  6, 2022 at 10:11:54PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/14/plpgsql-errors-and-messages.html
> Description:
> 
> Dear Sirs,
>   From the page on RAISE ...
>   I read this 3 times and tripped over "write a format", which should be use
> (or specify) a format string ...
> 
> Current:
> After level if any, you can write a format (which must be a simple string
> literal, not an expression). The format string specifies the error message
> text to be reported. 
> 
> Suggested Rewrite:
> After level if any, you can specify a format string (which must be a simple
> string literal, not an expression). The format string specifies the error
> message text to be reported. 

Good idea, patch attached.

-- 
  Bruce Momjian  <[email protected]>        https://momjian.us
  EDB                                      https://enterprisedb.com

  Indecision is a decision.  Inaction is an action.  Mark Batterson



Attachments:

  [text/x-diff] format.diff (612B, 2-format.diff)
  download | inline diff:
diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml
index d9a74896d5..cedc11ab1f 100644
--- a/doc/src/sgml/plpgsql.sgml
+++ b/doc/src/sgml/plpgsql.sgml
@@ -3778,7 +3778,7 @@ RAISE ;
 
    <para>
     After <replaceable class="parameter">level</replaceable> if any,
-    you can write a <replaceable class="parameter">format</replaceable>
+    you can specify a <replaceable class="parameter">format string</replaceable>
     (which must be a simple string literal, not an expression).  The
     format string specifies the error message text to be reported.
     The format string can be followed

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: Unclear Wording
  In-Reply-To: <Yp/[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox