Re: Add small detail to RAISE statement descripton - Mailing list pgsql-docs

From Igor Gnatyuk
Subject Re: Add small detail to RAISE statement descripton
Date
Msg-id CAEu6iLuoJe1xLzazw6nwrCk4VDKCwOaBL1R0XtzkWq+TBjAL_Q@mail.gmail.com
Whole thread Raw
In response to Re: Add small detail to RAISE statement descripton  (Laurenz Albe <laurenz.albe@cybertec.at>)
Responses Re: Add small detail to RAISE statement descripton
List 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.albe@cybertec.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

pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: 13.2.2. Repeatable Read Isolation Level #
Next
From: Laurenz Albe
Date:
Subject: Re: Add small detail to RAISE statement descripton