Re: small patch - Mailing list pgsql-docs

From Laurenz Albe
Subject Re: small patch
Date
Msg-id 9f703511c57d6bb0f44f9a968414869854ae50ea.camel@cybertec.at
Whole thread Raw
In response to Re: small patch  (rir <rirans@comcast.net>)
Responses Re: small patch  (rir <rirans@comcast.net>)
List pgsql-docs
On Wed, 2021-10-06 at 23:39 -0400, rir wrote:
> On Mon, Oct 04, 2021 at 08:18:22AM +0200, Laurenz Albe wrote:
> > On Fri, 2021-10-01 at 21:06 -0400, rir wrote:
> > > Minor changes to move.sgml and fetch.sgml.
> > > 
> > > The text 'or empty' is inconsistent by restating what the
> > > synopsis notation has expressed.
> > > 
> > > The comments on sharing a language feature, while
> > > likely helpful during review, seem verbose compared to
> > > the non-commenting in other similar files.
> > 
> > Thanks for the effort of preparing a patch.
> > 
> > However, I don't think that is an improvement:
> > 
> > - the comments pointing from MOVE to FETCH and vice versa are
> >   helpful for people who edit the documentation like you did
> > - we should retain "empty or one of", otherwise the following syntax
> >   would be undocumented:
> > 
> >       FETCH FROM c;
> 
> Your view is completely reasonable, but it suggests that
> many of the synopses are leaving syntax undocumented.
> The 'empty or one of:' is only used in these two synopses.

You have a point there.

Can you think of a way to modify the syntax diagram so that it
expresses that and still remains comprehensible?

Yours,
Laurenz Albe




pgsql-docs by date:

Previous
From: rir
Date:
Subject: Re: small patch
Next
From: Sanjeev Adwal
Date:
Subject: Re: Correction to documentation at https://www.postgresql.org/docs/12/kernel-resources.html