Re: Add small detail to RAISE statement descripton

From: Igor Gnatyuk <ig953or(at)gmail(dot)com>
To: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
Cc: jian he <jian(dot)universality(at)gmail(dot)com>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Add small detail to RAISE statement descripton
Date: 2024-07-15 18:30:24
Message-ID: CAEu6iLuoJe1xLzazw6nwrCk4VDKCwOaBL1R0XtzkWq+TBjAL_Q@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Hi, thanks for the review.
I tried to take your comments into account:

- added a missing comma
- still left a verbose version ;)
- made the last sentence more complete (according to the 2nd option).

Attached you will find new patch version fix_doc_raise_v4.patch,
please check it out.
Thanks again for review and comments.

Regards, Igor Gnatyuk

ср, 10 июл. 2024 г. в 23:36, Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>:
>
> On Wed, 2024-05-22 at 18:34 +0300, Igor Gnatyuk wrote:
> > fix_doc_raise_v3-bios.patch. Please check it out.
>
> I think the patch is fine.
>
> > + <para>
> > + <replaceable class="parameter">condition_name</replaceable> and
> > + <replaceable class="parameter">sqlstate</replaceable> specify
> > + error condition name and the five-character SQLSTATE code respectively.
> > + See <xref linkend="errcodes-appendix"/> for more information.
> > + </para>
>
> There should be a comma before "respectively".
>
> > You can attach additional information to the error report by writing
> > <literal>USING</literal> followed by <replaceable
> > class="parameter">option</replaceable> = <replaceable
> > - class="parameter">expression</replaceable> items. Each
> > + class="parameter">expression</replaceable> or
> > + <replaceable class="parameter">option</replaceable> :=
> > + <replaceable class="parameter">expression</replaceable>
> > + items, where
> > <replaceable class="parameter">expression</replaceable> can be any
> > string-valued expression.
>
> I think that is unnecessarily verbose. The original wording was fine;
> everybody can see from the syntax diagram that you can also use :=
>
> But I won't fight over it.
>
> > + In the <command>RAISE</command> command syntax with
> > + <replaceable class="parameter">condition_name</replaceable> or
> > + <replaceable class="parameter">sqlstate</replaceable> you can
> > + additionally use the <literal>USING</literal> clause too.
> > + A variation of the example above:
>
> I think that the final sentence should be more complete.
> Suggestions:
>
> Here is a variation of the above example:
>
> A variation of the above example is:
>
> Yours,
> Laurenz Albe

Attachment Content-Type Size
fix_doc_raise_v4.patch text/x-patch 5.7 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Laurenz Albe 2024-07-16 01:18:58 Re: Add small detail to RAISE statement descripton
Previous Message PG Doc comments form 2024-07-14 06:47:03 13.2.2. Repeatable Read Isolation Level #