pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Laurenz Albe <laurenz.albe@cybertec.at>
To: Igor Gnatyuk <ig953or@gmail.com>
To: jian he <jian.universality@gmail.com>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: Add small detail to RAISE statement descripton
Date: Wed, 10 Jul 2024 22:36:27 +0200
Message-ID: <2e89d99c849875e741fb399f91a4b234240cf3f6.camel@cybertec.at> (raw)
In-Reply-To: <CAEu6iLvde6Pe9pvacVD8Ni5oLFgSH2yE-cE+s=yM9b0byOb3TA@mail.gmail.com>
References: <CAEu6iLvhF5sdGeat2x4_L0FvWW_SiN--ma8ya7CZd-oJoV+yqQ@mail.gmail.com>
	<CACJufxEcbGJb5f7NGQ+9WXaK2ihBZbfQBUnwR56r-V3SdxkKJg@mail.gmail.com>
	<CAEu6iLuwjyhP8LMb5++V0NEdP_7-44xt=wS_bVuUJZXxjUXQdQ@mail.gmail.com>
	<CACJufxH_1G+gEHkrqVRey0-+A8yC3vRUb_kH195-YkzAv3nxXQ@mail.gmail.com>
	<CAEu6iLsL+Gw79f-8ZdU-GPnHXgSeEcPCk5qu9BcE1FRfO8Qbgg@mail.gmail.com>
	<CACJufxEu+nCkQ6hLxwpFYNhCLJvCzFNOu=A5FhFc=+o5CUZJ2Q@mail.gmail.com>
	<CAEu6iLvde6Pe9pvacVD8Ni5oLFgSH2yE-cE+s=yM9b0byOb3TA@mail.gmail.com>

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





view thread (12+ messages)  latest in thread

Message-ID: <2e89d99c849875e741fb399f91a4b234240cf3f6.camel@cybertec.at>
Permalink:  ../2e89d99c849875e741fb399f91a4b234240cf3f6.camel@cybertec.at/
Also on:    postgresql.org/message-id/2e89d99c849875e741fb399f91a4b234240cf3f6.camel@cybertec.at

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: laurenz.albe@cybertec.at, ig953or@gmail.com, jian.universality@gmail.com, pgsql-docs@lists.postgresql.org
  Subject: Re: Add small detail to RAISE statement descripton
  In-Reply-To: <2e89d99c849875e741fb399f91a4b234240cf3f6.camel@cybertec.at>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox