Re: [Doc] Glossary Term Definitions Edits

From: Erik Wienhold <ewie(at)ewie(dot)name>
To: Andrew Atkinson <andyatkinson(at)gmail(dot)com>
Cc: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: [Doc] Glossary Term Definitions Edits
Date: 2023-10-14 05:55:53
Message-ID: 75vhzoh2gz4xefcrhwr5ozq34qaq6vfvnmpqkbjl237oztnlj7@7fnxrzex2yqt
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 2023-10-14 06:16 +0200, Andrew Atkinson write:
> - When describing options for a command, changed to “option of” instead
> of “option to”

I think "option to" is not wrong (maybe less common). I've seen this
in other texts and took it as "the X option [that applies] to Y".

> - “system- or user-supplied”, removed the dash after system. Or I’d
> suggest system-supplied or user-supplied, to hyphenate both.

That's a suspended hyphen and is common usage.

> - Changed “volume of records has been written” to “volume of records
> were written”

"Has been" means that something happened just now. This is perfectly
fine when talking about checkpoints IMO.

> - Many examples of “an SQL”. I changed those to “a SQL...”. For example
> I changed “An SQL command which” to “A SQL command that”. I'm not an
> English major so maybe I'm missing something here.

Depends on how you pronounce SQL (ess-cue-el or sequel). "An SQL"
is more common in the docs whereas "a SQL" is more common in code
comments.

--
Erik

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Erki Eessaar 2023-10-14 07:31:24 Re: PostgreSQL domains and NOT NULL constraint
Previous Message David Rowley 2023-10-14 05:24:32 Re: [Doc] Glossary Term Definitions Edits