Misleading "For more information..." placement

From: PG Doc comments form <noreply(at)postgresql(dot)org>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: rsindlin(at)gmail(dot)com
Subject: Misleading "For more information..." placement
Date: 2023-03-25 15:43:56
Message-ID: 167975903644.3349096.5840068880132333322@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/15/datatype-character.html
Description:

In the paragraph

> The characters that can be stored in any of these data types are
determined by the database character set, which is selected when the
database is
> created. Regardless of the specific character set, the character with code
zero (sometimes called NUL) cannot be stored. For more information refer to
Section 24.3.

The final sentence ("For more information refer to Section 24.3") is easily
read to refer to more information being available about character code zero
(NUL). However, section 24.3 has no mention of NUL, but rather the
available database character sets. I'd suggest moving that last sentence to
immediately after the first sentence, which ends with "...when the database
is created."

A really minor point, but it caught me off-guard.

Best,
-Randall

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Erik Wienhold 2023-03-25 16:48:05 Re: Split_Part w/negative integer does not work
Previous Message PG Doc comments form 2023-03-24 20:45:47 Split_Part w/negative integer does not work