Re: On /*----- comments

Tom Lane <tgl@sss.pgh.pa.us>

From: Tom Lane <tgl@sss.pgh.pa.us>
To: Heikki Linnakangas <hlinnaka@iki.fi>
Cc: pgsql-hackers <pgsql-hackers@postgresql.org>
Date: 2023-06-30T15:22:15Z
Lists: pgsql-hackers
Heikki Linnakangas <hlinnaka@iki.fi> writes:
> Except for the translator comments, I think those others forgot about 
> the end-guards by accident. But they look just as nice to me. It's 
> probably not worth the code churn to remove them from existing comments, 
> but how about we stop requiring them in new code, and update the 
> pgindent README accordingly?

Seems reasonable; the trailing dashes eat a line without adding much.

Should we also provide specific guidance about how many leading dashes
to use for this?  I vaguely recall that pgindent might only need one,
but I think using somewhere around 5 to 10 looks better.

			regards, tom lane



Commits

  1. Change example in pgindent README on "/*-----" comments.

  2. Refactor WAL file-reading code into WALRead()