Re: Make --help output fit within 80 columns per line - Mailing list pgsql-hackers

From torikoshia
Subject Re: Make --help output fit within 80 columns per line
Date
Msg-id 3df2369f6002326ef057d88930f1adf4@oss.nttdata.com
Whole thread Raw
In response to Re: Make --help output fit within 80 columns per line  (Peter Eisentraut <peter@eisentraut.org>)
List pgsql-hackers
On 2023-09-12 15:27, Peter Eisentraut wrote:
> I like this work a lot.  It's good to give developers easy to verify
> guidance about formatting the --help messages.
> 
> However, I think instead of just adding a bunch of line breaks to
> satisfy the test, we should really try to make the lines shorter by
> rewording.  Otherwise, chances are we are making the usability worse
> for many users, because it's more likely that part of the help will
> scroll off the screen.  For example, in many cases, we could replace
> "do not" by "don't", or we could decrease the indentation of the
> second column by a few spaces, or just reword altogether.
> 
> Also, it would be very useful if the TAP test function could print out
> the violating lines if a test fails.  (Similar to how is() and like()
> print the failing values.)  Maybe start with that, and then it's
> easier to play with different wording variants to try to make it fit
> better.

Thanks for the review!
I'll try to fix the patch according to your comments.

-- 
Regards,

--
Atsushi Torikoshi
NTT DATA Group Corporation



pgsql-hackers by date:

Previous
From: Tatsuo Ishii
Date:
Subject: Re: Row pattern recognition
Next
From: Serpent
Date:
Subject: Re: Document that PG_TRY block cannot have a return statement