public inbox for [email protected]help / color / mirror / Atom feed
Unclear Wording 6+ messages / 4 participants [nested] [flat]
* Unclear Wording @ 2022-06-06 22:11 PG Doc comments form <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: PG Doc comments form @ 2022-06-06 22:11 UTC (permalink / raw) To: [email protected]; +Cc: [email protected] 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 ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Unclear Wording @ 2022-06-08 00:15 Bruce Momjian <[email protected]> parent: PG Doc comments form <[email protected]> 0 siblings, 2 replies; 6+ messages in thread From: Bruce Momjian @ 2022-06-08 00:15 UTC (permalink / raw) To: [email protected]; [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 ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Unclear Wording @ 2022-06-08 02:34 Laurenz Albe <[email protected]> parent: Bruce Momjian <[email protected]> 1 sibling, 0 replies; 6+ messages in thread From: Laurenz Albe @ 2022-06-08 02:34 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; [email protected]; [email protected] 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 ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Unclear Wording @ 2022-06-08 17:49 Peter Eisentraut <[email protected]> parent: Bruce Momjian <[email protected]> 1 sibling, 1 reply; 6+ messages in thread From: Peter Eisentraut @ 2022-06-08 17:49 UTC (permalink / raw) To: Bruce Momjian <[email protected]>; [email protected]; [email protected] 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. ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Unclear Wording @ 2022-06-08 19:07 Bruce Momjian <[email protected]> parent: Peter Eisentraut <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: Bruce Momjian @ 2022-06-08 19:07 UTC (permalink / raw) To: Peter Eisentraut <[email protected]>; +Cc: [email protected]; [email protected] 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 <[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..cf387dfc3f 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</replaceable> 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 ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Unclear Wording @ 2022-06-22 21:00 Bruce Momjian <[email protected]> parent: Bruce Momjian <[email protected]> 0 siblings, 0 replies; 6+ messages in thread From: Bruce Momjian @ 2022-06-22 21:00 UTC (permalink / raw) To: Peter Eisentraut <[email protected]>; +Cc: [email protected]; [email protected] 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 <[email protected]> https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson ^ permalink raw reply [nested|flat] 6+ messages in thread
end of thread, other threads:[~2022-06-22 21:00 UTC | newest] Thread overview: 6+ messages (download: mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2022-06-06 22:11 Unclear Wording PG Doc comments form <[email protected]> 2022-06-08 00:15 ` Bruce Momjian <[email protected]> 2022-06-08 02:34 ` Laurenz Albe <[email protected]> 2022-06-08 17:49 ` Peter Eisentraut <[email protected]> 2022-06-08 19:07 ` Bruce Momjian <[email protected]> 2022-06-22 21:00 ` Bruce Momjian <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox