Обсуждение: Unclear Wording
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. PS: Thank you for some of the best documentation ever published! The link, just in case: https://www.postgresql.org/docs/14/plpgsql-errors-and-messages.html
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 <bruce@momjian.us> https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson
Вложения
On Tue, 2022-06-07 at 20:15 -0400, Bruce Momjian wrote: > > 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. +1 Yours, Laurenz Albe
On 08.06.22 02:15, Bruce Momjian wrote: > - you can write a <replaceable class="parameter">format</replaceable> > + you can specify a <replaceable class="parameter">format string</replaceable> The "format" refers to the earlier synopsis, so that should be changed, too. Or put the "string" outside the <replaceable> element.
On Wed, Jun 8, 2022 at 07:49:07PM +0200, Peter Eisentraut wrote: > On 08.06.22 02:15, Bruce Momjian wrote: > > - you can write a <replaceable class="parameter">format</replaceable> > > + you can specify a <replaceable class="parameter">format string</replaceable> > > The "format" refers to the earlier synopsis, so that should be changed, too. > Or put the "string" outside the <replaceable> element. I thought about moving it outside, so I did that in this patch. -- Bruce Momjian <bruce@momjian.us> https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson
Вложения
On Wed, Jun 8, 2022 at 03:07:01PM -0400, Bruce Momjian wrote: > On Wed, Jun 8, 2022 at 07:49:07PM +0200, Peter Eisentraut wrote: > > On 08.06.22 02:15, Bruce Momjian wrote: > > > - you can write a <replaceable class="parameter">format</replaceable> > > > + you can specify a <replaceable class="parameter">format string</replaceable> > > > > The "format" refers to the earlier synopsis, so that should be changed, too. > > Or put the "string" outside the <replaceable> element. > > I thought about moving it outside, so I did that in this patch. Patch applied to all supported versions of Postgres. -- Bruce Momjian <bruce@momjian.us> https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson