Documentation on pgdump(1) uses "regular expression" instead of "psql pattern"

From: PG Doc comments form <noreply(at)postgresql(dot)org>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: mjf(at)mjf(dot)cz
Subject: Documentation on pgdump(1) uses "regular expression" instead of "psql pattern"
Date: 2022-09-22 10:53:18
Message-ID: 166384399811.653.17044611374895108084@wrigleys.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2022-09-23 02:17:16 Re: Documentation on pgdump(1) uses "regular expression" instead of "psql pattern"
Previous Message Tom Lane 2022-09-20 23:11:45 Re: Extension-specific version release notes?