| From: | "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> |
|---|---|
| To: | Matemática A3K <matematica(dot)a3k(at)gmail(dot)com> |
| Cc: | Oleg <o(dot)sibiryakov(at)postgrespro(dot)ru>, pgsql-docs(at)lists(dot)postgresql(dot)org |
| Subject: | Re: Documentation improvement patch |
| Date: | 2026-10-09 19:38:55 |
| Message-ID: | CAKFQuwb-2js636_tHms6hOoYfGrora2MOUmpXKoj3EOvVP3EOA@mail.gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-docs |
On Fri, Oct 9, 2026 at 10:43 AM Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>
wrote:
> On Fri, Oct 9, 2026 at 9:46 AM Oleg <o(dot)sibiryakov(at)postgrespro(dot)ru> wrote:
>
>> Dear all,
>>
>> I have prepared a patch containing some minor inconsistencies in the documentation.
>> Please, take a look.
>>
>> I will be looking forward to your feedback.
>>
>
> Mine would be: "Wow! What a sharp eye! Congratulations! I reviewed all
> your proposed changes and agree with all of them, +1"
>
>
Neither of the first two changes seems correct to me.
Third one is good. So maybe it's just the wanting to use commas where they
are unnecessary or incorrect that I'd push back on.
First it correctly adds missing periods then incorrectly removes others.
Using substring makes sense.
Most of these do seem to be unambiguous corrections.
For Oid -> OID - the documentation is inconsistent but favors Oid ...
/*
- * Retrieve the string value of an HBA option which was registered via
+ * Retrieve the string value of an HBA option, which was registered via
* RegisterOAuthHBAOptions(). Usable only during validate_cb or
shutdown_cb.
*
Another unneeded comma and passed up the chance to use 'that' like in prior
changes.
I stopped about half way. Suggest breaking these according to the problem
being corrected. But I don't trust your present ability to know when to
introduce commas to the prose. I am also unsure whether we really care
about adhering to Oxford commas.
David J.
| From | Date | Subject | |
|---|---|---|---|
| Next Message | David G. Johnston | 2026-10-09 21:07:37 | Re: ALTER SCHEMA: renaming does not update string-literal function bodies |
| Previous Message | PG Doc comments form | 2026-10-09 19:32:06 | ALTER SCHEMA: renaming does not update string-literal function bodies |