Section 9.7.3.2. Bracket Expressions should be rewritten

From: PG Doc comments form <noreply(at)postgresql(dot)org>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: zack02469(at)yahoo(dot)com
Subject: Section 9.7.3.2. Bracket Expressions should be rewritten
Date: 2022-10-12 14:08:29
Message-ID: 166558370911.591811.13134615993053243791@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/functions-matching.html
Description:

I am a Postgres newbie, and I find this part of what is generally excellent
documentation quite confusing. It contains the following disclaimer:

Note
PostgreSQL currently does not support multi-character collating elements.
This information describes possible future behavior.

I am very skeptical of the idea of documentation describing "possible future
behavior." Unless carefully done, this is guaranteed to cause confusion to
newbies such as myself. In this case, it is very unclear as to what the
disclaimer refers to. Is it referring to the previous 3 paragraphs, the
following 3 paragraphs, some subset of those paragraphs, or the entire
section? If reference to possible future behavior is deemed absolutely
necessary, then IMHO that portion of the docs should be blockquoted and
clearly marked as being forward-looking and not part of present behavior.

Furthermore, it appears that this disclaimer has been part of the docs since
at least version 10, so it's not even clear that this feature is even
currently being seriously considered for implementation.

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2022-10-12 14:38:55 Re: Server start with systemd and configured with IP address
Previous Message PG Doc comments form 2022-10-11 20:52:54 Server start with systemd and configured with IP address