Re: Add A Glossary

Justin Pryzby <pryzby@telsasoft.com>

From: Justin Pryzby <pryzby@telsasoft.com>
To: Jürgen Purtz <juergen@purtz.de>
Cc: Corey Huinker <corey.huinker@gmail.com>, Alvaro Herrera <alvherre@2ndquadrant.com>, Roger Harkavy <rogerharkavy@gmail.com>, pgsql-hackers@postgresql.org, Fabien COELHO <coelho@cri.ensmp.fr>, Michael Paquier <michael@paquier.xyz>
Date: 2020-03-31T17:58:45Z
Lists: pgsql-hackers, pgsql-docs
On Tue, Mar 31, 2020 at 04:13:00PM +0200, Jürgen Purtz wrote:
> Please find some minor suggestions in the attachment. They are based on
> Corey's last patch 0001-glossary-v4.patch.

> @@ -220,7 +220,7 @@
>        Record</glossterm>s to the file system and creates a special
>        checkpoint record. This process is initiated when predefined
>        conditions are met, such as a specified amount of time has passed, or
> -      a certain volume of records have been collected.
> +      a certain volume of records has been collected.

I think you're correct in that "volume" is singular.  But I think "collected"
is the wrong world.  I suggested "written".

>       <para>
> -      One of the <acronym>ACID</acronym> properties. This means that concurrently running 
> +      One of the <acronym>ACID</acronym> properties. This means that concurrently running

These could maybe say "required" or "essential" >ACID< properties

>       <para>
> +      In reference to a <glossterm>Table</glossterm>:
>        A <glossterm>Table</glossterm> that can be queried directly,

Maybe: "In reference to a >Relation<: A table which can be queried directly,"

>        table in the collection.
>       </para>
>       <para>
> -      When referring to an <glossterm>Analytic</glossterm>
> -      <glossterm>Function</glossterm>: a partition is a definition
> -      that identifies which neighboring
> +      In reference to a <glossterm>Analytic Function</glossterm>:
s/a/an/

> @@ -1333,7 +1334,8 @@
>      <glossdef>
>       <para>
>        The condition of having no duplicate values in the same
> -      <glossterm>Relation</glossterm>. Often used in the concept of
> +      <glossterm>Column</glossterm> of a <glossterm>Relation</glossterm>.
> +      Often used in the concept of

s/concept/context/, but  I said that before, so maybe it was rejected.

-- 
Justin



Commits

  1. Glossary: Add term "base backup"

  2. Minor glossary tweaks

  3. Adjust some glossary terms

  4. Fix more typos and grammar problems in the glossary

  5. Review of the glossary

  6. Add a glossary to the documentation