Re: Documentation improvement patch

Oleg <o.sibiryakov@postgrespro.ru>

From: Oleg Sibiryakov <o.sibiryakov@postgrespro.ru>
To: Peter Eisentraut <peter@eisentraut.org>, Daniel Gustafsson <daniel@yesql.se>
Cc: pgsql-docs@lists.postgresql.org
Date: 2024-09-13T10:50:14Z
Lists: pgsql-docs

Attachments

Here is a patch without the builtin/built-in corrections (find attached).

But I still believe the issue should be discussed further.
We actually have two options: it is either a spelling mistake (since 
built-in should written with a hyphen), or we miss the <literal> tag 
(since it is actually also a value).

So I do think we cannot really leave it as is.

-- 
Oleg Sibiryakov

On 11.09.2024 12:53, Peter Eisentraut wrote:
> On 10.09.24 15:02, Daniel Gustafsson wrote:
>>> On 10 Sep 2024, at 13:46, Oleg Sibiryakov 
>>> <o.sibiryakov@postgrespro.ru> wrote:
>>
>>> 1. Since we do not want to use <literal> here, I suggest we 
>>> hyphenate it as "built-in". What's your take on it?
>>
>> I think that's the right choice given the hyphenation used in the 
>> rest of the
>> docs.  There are a few more places on that same page which should be 
>> built-in
>> rather than builtin to separate the concept from the parameter value.
>
> I suspect that this would lead to the opposite confusion, people 
> complaining that the provider is called "builtin" not "built-in".
>
> Arguably, the other providers are also "built in".  There are no 
> user-pluggable providers at this time.
>
>
>

Commits

  1. doc: Missing markup, punctuation and wordsmithing