From: torikoshia <torikoshia@oss.nttdata.com>
To: Peter Eisentraut <peter@eisentraut.org>
Cc: Masahiro Ikeda <ikedamsh@oss.nttdata.com>
Cc: Pgsql Hackers <pgsql-hackers@postgresql.org>
Subject: Re: Make --help output fit within 80 columns per line
Date: Wed, 13 Sep 2023 21:40:46 +0900
Message-ID: <3df2369f6002326ef057d88930f1adf4@oss.nttdata.com> (raw)
In-Reply-To: <11f01df9-02ac-bc49-3f10-b7f2119ab7ce@eisentraut.org>
References: <50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com>
<3965013067e7b6195132da6c0b80a609@oss.nttdata.com>
<70043684388c1a8d181cf8f3308ad3ec@oss.nttdata.com>
<c20d4fa43995b3bfbb2c2d06b7ed8731@oss.nttdata.com>
<7ab6295d479544ae9acb926dc3e556cf@oss.nttdata.com>
<11f01df9-02ac-bc49-3f10-b7f2119ab7ce@eisentraut.org>
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients from your mail client; the link fills in
the headers below: reply via email
Some clients, webmail especially, drop In-Reply-To and References from
a link, and the reply then starts a new thread: use the mbox below.
To: pgsql-hackers@postgresql.org
Cc: torikoshia@oss.nttdata.com, peter@eisentraut.org, ikedamsh@oss.nttdata.com
Subject: Re: Make --help output fit within 80 columns per line
In-Reply-To: <3df2369f6002326ef057d88930f1adf4@oss.nttdata.com>
References: <50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com> <3965013067e7b6195132da6c0b80a609@oss.nttdata.com> <70043684388c1a8d181cf8f3308ad3ec@oss.nttdata.com> <c20d4fa43995b3bfbb2c2d06b7ed8731@oss.nttdata.com> <7ab6295d479544ae9acb926dc3e556cf@oss.nttdata.com> <11f01df9-02ac-bc49-3f10-b7f2119ab7ce@eisentraut.org> <3df2369f6002326ef057d88930f1adf4@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox