From: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
Cc: Kyotaro Horiguchi <horikyota.ntt@gmail.com>
Cc: pgsql-hackers@lists.postgresql.org
Subject: Re: create_help.pl treats <literal> as replaceable
Date: Wed, 18 May 2022 12:29:05 -0400
Message-ID: <17623.1652891345@sss.pgh.pa.us> (raw)
In-Reply-To: <b4773b4a-3c2c-336a-6904-297d9accd5dc@enterprisedb.com>
References: <20220517.174342.1884842412165214815.horikyota.ntt@gmail.com>
<1581685.1652800163@sss.pgh.pa.us>
<b4773b4a-3c2c-336a-6904-297d9accd5dc@enterprisedb.com>
Peter Eisentraut <peter.eisentraut@enterprisedb.com> writes:
> On 17.05.22 17:09, Tom Lane wrote:
>> Isn't that a documentation bug rather than a problem with create_help?
> Yeah, there is no need for a <literal> inside a <synopsis>. So I just
> removed it.
I think you should have upper-cased MATCH while at it, to make it clear
that it acts like a keyword in this context. The current situation is
quite unreadable in plain-ASCII output:
regression=# \help copy
Command: COPY
...
HEADER [ boolean | match ]
...
Since "boolean" is a metasyntactic variable here, it's absolutely
not obvious that "match" isn't.
regards, tom lane
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-hackers@postgresql.org
Cc: tgl@sss.pgh.pa.us, peter.eisentraut@enterprisedb.com, horikyota.ntt@gmail.com, pgsql-hackers@lists.postgresql.org
Subject: Re: create_help.pl treats <literal> as replaceable
In-Reply-To: <17623.1652891345@sss.pgh.pa.us>
* 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