From: PG Doc comments form <noreply@postgresql.org>
To: pgsql-docs@lists.postgresql.org
Cc: mjf@mjf.cz
Subject: Documentation on pgdump(1) uses "regular expression" instead of "psql pattern"
Date: Thu, 22 Sep 2022 10:53:18 +0000
Message-ID: <166384399811.653.17044611374895108084@wrigleys.postgresql.org> (raw)
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/14/app-pgdump.html
Description:
Hello.
the [1] uses term "regular expression" where "psql pattern" [2] should be
used instead which
may be misleading (and might cause even some harm in some edge usage
cases).
I therefor propose to improve the documentation by emphasizing (strongly)
the fact that the
"regular expression" is in fact (psql) "pattern" and have nothing to do with
*common* regular
expressions and therefor extra care should be taken when using them. (From
my point of view,
the best would be to lead the reader directly to the [2], preferably
somewhere at the beginning
of the document/page, and also mention it again in the section with the
examples by replacing
the wrong term "regular expressions" with "patterns" hyperlinked to [2].)
- [1]
https://www.postgresql.org/docs/current/app-pgdump.html#PG-DUMP-EXAMPLES
- [2]
https://www.postgresql.org/docs/current/app-psql.html#APP-PSQL-PATTERNS
Sincerely,
--
mjf
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: noreply@postgresql.org, pgsql-docs@lists.postgresql.org, mjf@mjf.cz
Subject: Re: Documentation on pgdump(1) uses "regular expression" instead of "psql pattern"
In-Reply-To: <166384399811.653.17044611374895108084@wrigleys.postgresql.org>
* 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