Обсуждение: Fix typo in comment

Поиск
Список
Период
Сортировка

Fix typo in comment

От
Zaorang Yang
Дата:
Maybe, the first letter of comments in postinit.c should be capitalized. Attaching a tiny patch to fix it.
Вложения

Re: Fix typo in comment

От
Alvaro Herrera
Дата:
On 2022-May-06, Zaorang Yang wrote:

> Maybe, the first letter of comments in postinit.c should be capitalized.

Hmm, typically these one-line comments are not "full sentences", so they
don't have capitals and no ending periods either.  I wouldn't like the
endless stream of patches that would result if we let this go in.

-- 
Álvaro Herrera         PostgreSQL Developer  —  https://www.EnterpriseDB.com/



Re: Fix typo in comment

От
Daniel Gustafsson
Дата:
> On 6 May 2022, at 14:50, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
> 
> On 2022-May-06, Zaorang Yang wrote:
> 
>> Maybe, the first letter of comments in postinit.c should be capitalized.
> 
> Hmm, typically these one-line comments are not "full sentences", so they
> don't have capitals and no ending periods either.  I wouldn't like the
> endless stream of patches that would result if we let this go in.

Agreed. A quick grep turns up a fair number of such comments:

 $ git grep "^\s*\/\* [a-z].\+\*\/$" src/ | wc -l
   16588

If anything should be done to this it would perhaps be better to add to
pgindent or a similar automated process.  If anything.

--
Daniel Gustafsson        https://vmware.com/




Re: Fix typo in comment

От
Tom Lane
Дата:
Alvaro Herrera <alvherre@alvh.no-ip.org> writes:
> On 2022-May-06, Zaorang Yang wrote:
>> Maybe, the first letter of comments in postinit.c should be capitalized.

> Hmm, typically these one-line comments are not "full sentences", so they
> don't have capitals and no ending periods either.  I wouldn't like the
> endless stream of patches that would result if we let this go in.

There is no project style guideline suggesting one over the other, so
I think we should just leave it alone.

            regards, tom lane