Re: Duplicat-word typos in code comments

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: Dagfinn Ilmari Mannsåker <ilmari(at)ilmari(dot)org>, pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Duplicat-word typos in code comments
Date: 2021-10-04 19:54:00
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

Daniel Gustafsson <daniel(at)yesql(dot)se> writes:
>> On 4 Oct 2021, at 15:56, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>> I used to think it was better to go ahead and manually reflow, if you
>> use an editor that makes that easy. That way there are fewer commits
>> touching any one line of code, which is good when trying to review
>> code history. However, now that we've got the ability to make "git
>> blame" ignore pgindent commits, maybe it's better to leave that sort
>> of mechanical cleanup to pgindent, so that the substantive patch is
>> easier to review.

> Yeah, that's precisely why I did it. Since we can skip over pgindent sweeps it
> makes sense to try and minimize such changes to make code archaeology easier.
> There are of course cases when the result will be such an eyesore that we'd
> prefer to have it done sooner, but in cases like these where line just got one
> word shorter it seemed an easy choice.

Actually though, there's another consideration: if you leave
not-correctly-pgindented code laying around, it causes problems
for the next hacker who modifies that file and wishes to neaten
up their own work by pgindenting it. They can either tediously
reverse out part of the delta, or commit a patch that includes
entirely-unrelated cosmetic changes, neither of which is

regards, tom lane

In response to


Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Geoghegan 2021-10-04 20:37:30 Re: BUG #17212: pg_amcheck fails on checking temporary relations
Previous Message Victor Spirin 2021-10-04 19:51:09 Re: Atomic rename feature for Windows.