Обсуждение: Misleading "For more information..." placement

Поиск
Список
Период
Сортировка

Misleading "For more information..." placement

От
PG Doc comments form
Дата:
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

Re: Misleading "For more information..." placement

От
Daniel Gustafsson
Дата:
> On 25 Mar 2023, at 16:43, PG Doc comments form <noreply@postgresql.org> wrote:

> 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."

I think sentence with the link is better at the end, how about if we reword it
slightly to something like this to make it clearer?

        "For more information on character sets refer to Section 24.3"

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

In Postgres we excel at caring about minor points, so thanks for your report!

--
Daniel Gustafsson




Re: Misleading "For more information..." placement

От
Randall Sindlinger
Дата:
>On Sun, Mar 26, 2023 at 5:18 PM Daniel Gustafsson <daniel@yesql.se> wrote:
>
> > I'd suggest moving that last sentence to
> > immediately after the first sentence, which ends with "...when the database
> > is created."
>
> I think sentence with the link is better at the end, how about if we reword it
> slightly to something like this to make it clearer?
>
>         "For more information on character sets refer to Section 24.3"

I did notice that a link at the end seems to be the doc's style, so, sure -
that works for me.

>
> In Postgres we excel at caring about minor points, so thanks for your report!

Fantastic!  I'm rather used to things just going off into the ether.
I know I've
seen minor things before, so next time I notice one, I'll send it in.
I've been delving into the docs a fair bit recently :- )


-Randall



Re: Misleading "For more information..." placement

От
Daniel Gustafsson
Дата:
> On 27 Mar 2023, at 17:04, Randall Sindlinger <rsindlin@gmail.com> wrote:

> Fantastic!  I'm rather used to things just going off into the ether.
> I know I've
> seen minor things before, so next time I notice one, I'll send it in.

Please do, postgres is made by the community and no report is too small to be
valuable.

--
Daniel Gustafsson