Re: Documentation improvement patch - Mailing list pgsql-docs

From Oleg Sibiryakov
Subject Re: Documentation improvement patch
Date
Msg-id 2a9455d8-2938-4346-93bc-2eb02b6261e0@postgrespro.ru
Whole thread Raw
In response to Re: Documentation improvement patch  (Daniel Gustafsson <daniel@yesql.se>)
Responses Re: Documentation improvement patch
List pgsql-docs
Thank you for your feedback.

1. Since we do not want to use <literal> here, I suggest we hyphenate it 
as "built-in". What's your take on it?
2. Leaving not-null is fine.

--
Oleg Sibiryakov

On 06.09.2024 16:20, Daniel Gustafsson wrote:
>> On 5 Sep 2024, at 11:33, Oleg Sibiryakov <o.sibiryakov@postgrespro.ru> wrote:
>>
>> Dear all,
>> I have prepared a patch containing some minor inconsistencies in the documentation. Please, take a look.
>> The inconsistencies were noticed by: Ekaterina Kiryanova, Elena Indrupskaya, Maxim Yablokov, Anna Uraskova, Elena
Karavaeva,and me.
 
>> We will be looking forward to your feedback.
>> The patch shall be applied to the REL_17_STABLE branch.
> Most of these seem fine, but I need another read-through to digest them fully.
> Just a few small comments:
>
> -        Specifies the builtin provider locale for the database default
> -        collation order and character classification, overriding the setting
> -        <xref linkend="create-database-locale"/>.  The <link
> +        Specifies the <literal>builtin</literal> provider locale for the database
> +        default collation order and character classification, overriding the
> +        setting <xref linkend="create-database-locale"/>.  The <link
> and
> -        Specifies the locale name when the builtin provider is used. Locale support
> -        is described in <xref linkend="locale"/>.
> +        Specifies the locale name when the <literal>builtin</literal> provider
> +        is used. Locale support is described in <xref linkend="locale"/>.
>
>
> I don't think this use of "builtin" refers to the config value but rather the
> type of locale, so I think it's correct to not use <literal> here.
>
>
> -    for not-null constraints at all, so they are not
> +    for <literal>NOT NULL</literal> constraints at all, so they are not
>
> This seems mostly to be a question of taste, I don't think not-null is
> incorrect here.
>
> --
> Daniel Gustafsson
>
>
>



pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: Mathematical Functions and Operators
Next
From: Daniel Gustafsson
Date:
Subject: Re: Documentation improvement patch