pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: rir <rirans@comcast.net>
To: Laurenz Albe <laurenz.albe@cybertec.at>
Cc: rir <rirans@comcast.net>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: small patch
Date: Wed, 6 Oct 2021 23:39:05 -0400
Message-ID: <20211007033905.pmsg5qnyqceepfva@localhost> (raw)
In-Reply-To: <1c0eefa304434f67fd6a5a9d3f420d59ac74623a.camel@cybertec.at>
References: <20211001163938.ifg4ayrsjwd7r6zr@localhost>
	<1c0eefa304434f67fd6a5a9d3f420d59ac74623a.camel@cybertec.at>

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;

> Yours,
> Laurenz Albe

Laurenz,

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.

If I had found the comments helpful, I would have spared them.
My sense was that the comments were unusual by their existence
for their purpose.  That was not rigorous:  so okay.

Since I'm only making the same points again, I'll stop.

Thanks again,
Rob





view thread (16+ messages)  latest in thread

Message-ID: <20211007033905.pmsg5qnyqceepfva@localhost>
Permalink:  ../20211007033905.pmsg5qnyqceepfva@localhost/
Also on:    postgresql.org/message-id/20211007033905.pmsg5qnyqceepfva@localhost

 · 

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: rirans@comcast.net, laurenz.albe@cybertec.at, pgsql-docs@lists.postgresql.org
  Subject: Re: small patch
  In-Reply-To: <20211007033905.pmsg5qnyqceepfva@localhost>

* 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