Postgres Pro
Downloads
Home   >   mailing lists

First Person being used (only occurs in 2 other places in all of documentation) - Mailing list pgsql-docs

From PG Doc comments form
Subject First Person being used (only occurs in 2 other places in all of documentation)
Date
Msg-id 166692508416.630.9910522387468316027@wrigleys.postgresql.org
Whole thread Raw
Responses Re: First Person being used (only occurs in 2 other places in all of documentation)  (Daniel Gustafsson <daniel@yesql.se>)
List pgsql-docs
Tree view 
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!

pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: Cursor Names are "Session Global while Opened"? (should be mentioned in the docs)
Next
From: PG Doc comments form
Date:
Subject: Use of First Person (I) in Documentation