Re: clean up docs for v12

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Justin Pryzby <pryzby(at)telsasoft(dot)com>
Cc: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, Andres Freund <andres(at)anarazel(dot)de>, pgsql-hackers(at)postgresql(dot)org
Subject: Re: clean up docs for v12
Date: 2019-04-27 04:57:00
Message-ID: 20190427045700.GG2032@paquier.xyz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Apr 26, 2019 at 09:56:47PM -0500, Justin Pryzby wrote:
> But here's some one-liner excerpts.
>
> - is <literal>2</literal> bits and maximum is <literal>4095</literal>. Parameters for
> + is <literal>2</literal> bits and the maximum is <literal>4095</literal>. Parameters for
>
> Adding "the" makes it a complete sentence and not a fragment.

Not sure here either that it matters.

> - all autovacuum actions. Minus-one (the default) disables logging
> + all autovacuum actions. <literal>-1</literal> (the default) disables logging
>
> There's nothing else that says "minus-one" anywhere else on that page. I just
> found one in auto-explain.sgml, which I changed.

That's one of these I am not sure about.

> - than 16KB; <function>gss_wrap_size_limit()</function> should be used by the
> + than 16kB; <function>gss_wrap_size_limit()</function> should be used by the
>
> Every other use in documentation has a lowercase "kay", and PG itself doesn't
> accept "KB" unit suffix.

Right. There are more places like that, particularly in the comments
of the code.

> - A few features included in the C99 standard are, at this time, not be
> + A few features included in the C99 standard are, at this time, not
> permitted to be used in core <productname>PostgreSQL</productname>
>
> Indisputably wrong ?

Yep, this one is wrong as-is.
--
Michael

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Fabien COELHO 2019-04-27 07:19:57 nRe: [PATCH v1] Show whether tables are logged in \dt+
Previous Message David Fetter 2019-04-27 04:18:49 Re: [PATCH v1] Show whether tables are logged in \dt+