Thread: Consistently use "startup process"/"WAL sender" instead of "Startup process"/"WAL Sender" in comments and docs.
Consistently use "startup process"/"WAL sender" instead of "Startup process"/"WAL Sender" in comments and docs.
From
Bharath Rupireddy
Date:
Hi, In the code comments, it is being used as "Startup process" in the middle of the sentences whereas in most of the places "startup process" is used. Also, "WAL Sender" is being used instead of "WAL sender". Let's be consistent across the docs and code comments. Attaching a patch. Thoughts? Regards, Bharath Rupireddy.
Attachment
Re: Consistently use "startup process"/"WAL sender" instead of "Startup process"/"WAL Sender" in comments and docs.
From
John Naylor
Date:
On Sun, Feb 13, 2022 at 3:13 PM Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com> wrote: > > Hi, > > In the code comments, it is being used as "Startup process" in the > middle of the sentences whereas in most of the places "startup > process" is used. Also, "WAL Sender" is being used instead of "WAL > sender". Let's be consistent across the docs and code comments. FWIW, docs need to hold to a higher standard than code comments. -- John Naylor EDB: http://www.enterprisedb.com
Re: Consistently use "startup process"/"WAL sender" instead of "Startup process"/"WAL Sender" in comments and docs.
From
Bharath Rupireddy
Date:
On Sun, Feb 13, 2022 at 5:49 PM John Naylor <john.naylor@enterprisedb.com> wrote: > > On Sun, Feb 13, 2022 at 3:13 PM Bharath Rupireddy > <bharath.rupireddyforpostgres@gmail.com> wrote: > > > > Hi, > > > > In the code comments, it is being used as "Startup process" in the > > middle of the sentences whereas in most of the places "startup > > process" is used. Also, "WAL Sender" is being used instead of "WAL > > sender". Let's be consistent across the docs and code comments. > > FWIW, docs need to hold to a higher standard than code comments. Thanks. In general, I agree that the docs and error/log messages (user-facing) need to be of higher standard, but at the same time code comments too IMHO. Because many hackers/developers consider code comments a great place to learn the internals, being consistent there does no harm. Regards, Bharath Rupireddy.
Re: Consistently use "startup process"/"WAL sender" instead of "Startup process"/"WAL Sender" in comments and docs.
From
John Naylor
Date:
On Mon, Feb 14, 2022 at 11:12 AM Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com> wrote: > > FWIW, docs need to hold to a higher standard than code comments. > > Thanks. In general, I agree that the docs and error/log messages > (user-facing) need to be of higher standard, but at the same time code > comments too IMHO. Because many hackers/developers consider code > comments a great place to learn the internals, being consistent there > does no harm. git log and git blame are more useful when they are free of minor stylistic changes. Of course, corrections and clarity are different matters that are worth fixing in the comments. I've pushed the doc fixes, thanks for the patch! -- John Naylor EDB: http://www.enterprisedb.com