Re: some grammar fixes for docs

Michael Paquier <[email protected]> Fri, 17 May 2019 08:32:53 +0900
Newsgroups	gmane.comp.db.postgresql.devel.documentation
Message-ID	<[email protected]>
On Thu, May 16, 2019 at 05:11:37PM +0300, Liudmila Mantrova wrote:
> I have noticed imperfect grammar in a couple of sgml files, please consider
> a small patch (attached).

Thanks, Liudmila for caring about such matters.

>         <para>
> -        Transaction which last more than <replaceable>limit</replaceable> milliseconds
> +        Transactions that last more than <replaceable>limit</replaceable> milliseconds
>          are counted and reported separately, as <firstterm>late</firstterm>.
>         </para>

I don't see much of a difference between "which" or "that" in this
context, and you are right about the plural for "Transactions".  Any
native English speaker around or anybody with an extra opinion?

>   <para>
>    Of the two operator classes for type <type>point</type>,
>    <literal>quad_point_ops</literal> is the default.  <literal>kd_point_ops</literal>
> -  supports the same operators but uses a different index data structure which
> +  supports the same operators but uses a different index data structure that
>    may offer better performance in some applications.
>   </para>

Same here.

> @@ -447,9 +447,9 @@ typedef struct spgChooseOut
>         type that was to be inserted into the index.
>         <structfield>leafDatum</structfield> is a value of
>         <structname>spgConfigOut</structname>.<structfield>leafType</structfield>
> -       type which is initially an result of method
> +       type, which is initially a result of method

I actually would not add a comma here, as the follow-up expression
gives more details about the leaf type previously mentioned.

>         <function>compress</function> applied to <structfield>datum</structfield>
> -       when method <function>compress</function> is provided, or same value as
> +       when method <function>compress</function> is provided, or the same value as

I would do what you suggest here.

>         Converts the data item into a format suitable for physical storage in
>         a leaf tuple of index page.  It accepts
>         <structname>spgConfigIn</structname>.<structfield>attType</structfield>
> -       value and return
> +       value and returns

This one is right.  Good catch.
--
Michael
signature.asc (application/pgp-signature, 833 B)