Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nyjM3-0000zP-CU for pgsql-docs@arkaria.postgresql.org; Wed, 08 Jun 2022 00:15:23 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.92) (envelope-from ) id 1nyjM2-0000PS-A8 for pgsql-docs@arkaria.postgresql.org; Wed, 08 Jun 2022 00:15:22 +0000 Received: from makus.postgresql.org ([2001:4800:3e1:1::229]) by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nyjM2-0000PJ-2k for pgsql-docs@lists.postgresql.org; Wed, 08 Jun 2022 00:15:22 +0000 Received: from momjian.us ([72.94.173.45]) by makus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nyjLz-0007Da-Th for pgsql-docs@lists.postgresql.org; Wed, 08 Jun 2022 00:15:21 +0000 Received: from bruce by momjian.us with local (Exim 4.94.2) (envelope-from ) id 1nyjLy-000x56-L3; Tue, 07 Jun 2022 20:15:18 -0400 Date: Tue, 7 Jun 2022 20:15:18 -0400 From: Bruce Momjian To: pg@kirasoft.com, pgsql-docs@lists.postgresql.org Subject: Re: Unclear Wording Message-ID: References: <165455351426.573551.7050474465030525109@wrigleys.postgresql.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="6CYCzO7NgbXgGRC+" Content-Disposition: inline In-Reply-To: <165455351426.573551.7050474465030525109@wrigleys.postgresql.org> List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk --6CYCzO7NgbXgGRC+ Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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 https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson --6CYCzO7NgbXgGRC+ Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="format.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 ; After level if any, - you can write a format + 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. The format string can be followed --6CYCzO7NgbXgGRC+--