From: | PG Doc comments form <noreply(at)postgresql(dot)org> |
---|---|
To: | pgsql-docs(at)lists(dot)postgresql(dot)org |
Cc: | wolakk(at)gmail(dot)com |
Subject: | First Person being used (only occurs in 2 other places in all of documentation) |
Date: | 2022-10-28 02:44:44 |
Message-ID: | 166692508416.630.9910522387468316027@wrigleys.postgresql.org |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-docs |
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/15/cube.html
Description:
I believe the use of First Person (I) is to be avoided in the documentation.
It is incredibly rare in all of the documentation.
This is a NUANCE issue, but so are white space comments in code!
I will paste in what is written => what is suggested (fix as you wish)
On this page:
F.9.4. Defaults
I believe this union: => This union:
Below that:
... I assume the ... => ... one can assume the ...
F.9.6. Credits
>> Note that changing the credits someone is giving might be pushing it, but
again, it does not exist like this elsewhere!
I am also grateful to all Postgres ... => With gratitude to all Postgres
...
And I would like to acknowledge my gratitude to Argonne ... => With further
gratitude to Argonne ...
[I will add a separate comment for the other 2 occurrences]
Thanks in advance!
From | Date | Subject | |
---|---|---|---|
Next Message | PG Doc comments form | 2022-10-28 02:51:04 | Use of First Person (I) in Documentation |
Previous Message | PG Doc comments form | 2022-10-27 19:45:09 | Cursor Names are "Session Global while Opened"? (should be mentioned in the docs) |