Minor fixes for PostgreSQL 13 documentation

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Minor fixes for PostgreSQL 13 documentation

Alexander Lakhin-2
Hello,

Please consider applying fixes for bugs (incorrect tags, redundant
spaces, etc.) I noticed while translating the documentation.

Best regards,
Alexander

fix-doc-13-bugs.patch (7K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Minor fixes for PostgreSQL 13 documentation

Michael Paquier-2
On Sat, Aug 22, 2020 at 01:10:11PM +0300, Alexander Lakhin wrote:
> Please consider applying fixes for bugs (incorrect tags, redundant
> spaces, etc.) I noticed while translating the documentation.

Thanks, Alexander.  I have applied and back-patched most of it down to
13.

> -     The function is passed a pointer to a <replaceable>local_relopts</replaceable>
> +     The function is passed a pointer to a <structname>local_relopts</structname>

The docs of brin, gin, gist and spgist disagree with that.  Wouldn't
it be better to update all of them?

> -        (1&ndash;31) ; for <type>interval</type> values, the number of days
> +        (1&ndash;31); for <type>interval</type> values, the number of days

This one is visibly intentional, as of cbd2811.

> -       <literal>libpq</literal>'s <link linkend="libpq-ssl-clientcert">default
> +       <application>libpq</application>'s <link linkend="libpq-ssl-clientcert">default

I have found a second instance of that, so fixed on the way.
--
Michael

signature.asc (849 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Minor fixes for PostgreSQL 13 documentation

Tom Lane-2
Michael Paquier <[hidden email]> writes:
> On Sat, Aug 22, 2020 at 01:10:11PM +0300, Alexander Lakhin wrote:
>> -     The function is passed a pointer to a <replaceable>local_relopts</replaceable>
>> +     The function is passed a pointer to a <structname>local_relopts</structname>

> The docs of brin, gin, gist and spgist disagree with that.  Wouldn't
> it be better to update all of them?

Yeah, probably.  See 47046763c for some policy I'd made up about when
to use <replaceable> --- typedef names definitely don't fit.

                        regards, tom lane


Reply | Threaded
Open this post in threaded view
|

Re: Minor fixes for PostgreSQL 13 documentation

Michael Paquier-2
On Sat, Aug 22, 2020 at 11:06:52AM -0400, Tom Lane wrote:
> Michael Paquier <[hidden email]> writes:
>> The docs of brin, gin, gist and spgist disagree with that.  Wouldn't
>> it be better to update all of them?
>
> Yeah, probably.  See 47046763c for some policy I'd made up about when
> to use <replaceable> --- typedef names definitely don't fit.

I have looked again at the documentation and found just the five
places mentioned previously, giving the attached.
--
Michael

doc-structname.patch (3K) Download Attachment
signature.asc (849 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Minor fixes for PostgreSQL 13 documentation

Michael Paquier-2
On Sun, Aug 23, 2020 at 09:11:58PM +0900, Michael Paquier wrote:
> I have looked again at the documentation and found just the five
> places mentioned previously, giving the attached.

And fixed with 77c1537, so we are done here.
--
Michael

signature.asc (849 bytes) Download Attachment