agora inbox for pgsql-docs@postgresql.org  
help / color / mirror / Atom feed
From: Oleg Sibiryakov <o.sibiryakov@postgrespro.ru>
To: Daniel Gustafsson <daniel@yesql.se>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: Documentation improvement patch
Date: Tue, 10 Sep 2024 14:46:23 +0300
Message-ID: <2a9455d8-2938-4346-93bc-2eb02b6261e0@postgrespro.ru> (raw)
In-Reply-To: <BAB3A99C-66CA-4377-9D19-71763045C9A4@yesql.se>
References: <b7d0a03c-107e-48c7-a5c9-2c6f73cdf78f@postgrespro.ru>
	<BAB3A99C-66CA-4377-9D19-71763045C9A4@yesql.se>

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





view thread (23+ messages)  latest in thread

Message-ID: <2a9455d8-2938-4346-93bc-2eb02b6261e0@postgrespro.ru>
Permalink:  ../2a9455d8-2938-4346-93bc-2eb02b6261e0@postgrespro.ru/
Also on:    postgresql.org/message-id/2a9455d8-2938-4346-93bc-2eb02b6261e0@postgrespro.ru

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: o.sibiryakov@postgrespro.ru, daniel@yesql.se, pgsql-docs@lists.postgresql.org
  Subject: Re: Documentation improvement patch
  In-Reply-To: <2a9455d8-2938-4346-93bc-2eb02b6261e0@postgrespro.ru>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox