Re: Make --help output fit within 80 columns per line

From: torikoshia <torikoshia(at)oss(dot)nttdata(dot)com>
To: Peter Eisentraut <peter(at)eisentraut(dot)org>
Cc: Masahiro Ikeda <ikedamsh(at)oss(dot)nttdata(dot)com>, Pgsql Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Make --help output fit within 80 columns per line
Date: 2023-09-13 12:40:46
Message-ID: 3df2369f6002326ef057d88930f1adf4@oss.nttdata.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Serpent 2023-09-13 12:49:17 Re: Document that PG_TRY block cannot have a return statement
Previous Message Tatsuo Ishii 2023-09-13 12:35:53 Re: Row pattern recognition