| From: | Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> |
|---|---|
| To: | Michael Paquier <michael(at)paquier(dot)xyz> |
| Cc: | zhanghu <kongbaik228(at)gmail(dot)com>, Postgres hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org> |
| Subject: | Re: Add documentation for PG_ABS_SRCDIR, PG_ABS_BUILDDIR, PG_LIBDIR, PG_DLSUFFIX |
| Date: | 2026-03-12 00:08:39 |
| Message-ID: | 65E3CAFA-104A-4544-89F3-08486478B53E@gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
> On Mar 12, 2026, at 05:34, Michael Paquier <michael(at)paquier(dot)xyz> wrote:
>
> On Wed, Mar 11, 2026 at 11:10:44AM +0800, zhanghu wrote:
>> The doc changes look good overall. I applied the patch locally and rendered
>> the documentation to HTML, the new page also looks good.
>>
>> A few minor nitpicks:
>>
>> + <para>
>> + Name of extension for dynamically-loadable modules (e.g.
>> + <literal>.so</literal> on Linux).
>> + </para>
>>
>> I think we need a "the" before "dynamically-loadable".
>
> Don't think this one's necessary here, actually, as it refers to a
> general concept around modules.
>
>> + These are useful when dealing with function and object loading
>> + that require specific paths to work, like paths defined in a
>> + <command>CREATE FUNCTION</command> or <command>LOAD</command>
>> + command, for example.
>>
>> The ending "for example" sounds redundant, since "like" already conveys the
>> meaning of "for example".
>
> WFM.
> --
> Michael
I checked d1029bb5a26c, and based on that, the doc change overall looks good to me.
I have a small observation regarding "e.g.”.
Since "e.g." is equivalent to "for example," and "for example" is commonly followed by a comma, my impression was that "e.g." should also follow one. I did a quick search across all SGML files to check the existing convention:
```
chaol(at)ChaodeMacBook-Air postgresql % grep -RohF --include='*.sgml' 'e.g.' . | wc -l
328
chaol(at)ChaodeMacBook-Air postgresql % grep -RohF --include='*.sgml' 'e.g.,' . | wc -l
239
chaol(at)ChaodeMacBook-Air postgresql % grep -RohF --include='*.sgml' 'e.g.:' . | wc -l
55
chaol(at)ChaodeMacBook-Air postgresql % grep -RohF --include='*.sgml' 'e.g. ' . | wc -l
31
```
It looks like the usage isn't entirely consistent, but the vast majority use a following punctuation mark. Only about 1/10 use "e.g." followed only by a space.
While the inconsistency is already there and a dedicated cleanup might not be worthwhile, my preference is still to limit the inconsistency.
Best regards,
--
Chao Li (Evan)
HighGo Software Co., Ltd.
https://www.highgo.com/
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Tatsuo Ishii | 2026-03-12 00:21:25 | Re: Row pattern recognition |
| Previous Message | Daniel Gustafsson | 2026-03-11 23:56:07 | Re: Changing the state of data checksums in a running cluster |