Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qgPAw-00FgDC-Bs for pgsql-hackers@arkaria.postgresql.org; Wed, 13 Sep 2023 12:40:58 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.94.2) (envelope-from ) id 1qgPAv-00HPIh-5D for pgsql-hackers@arkaria.postgresql.org; Wed, 13 Sep 2023 12:40:56 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qgPAu-00HPIX-QV for pgsql-hackers@lists.postgresql.org; Wed, 13 Sep 2023 12:40:56 +0000 Received: from oss.nttdata.com ([49.212.34.109]) by magus.postgresql.org with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qgPAq-004qKV-JE for pgsql-hackers@postgresql.org; Wed, 13 Sep 2023 12:40:56 +0000 Received: from oss.nttdata.com (localhost [127.0.0.1]) by oss.nttdata.com (Postfix) with ESMTPA id 91238605CA; Wed, 13 Sep 2023 21:40:46 +0900 (JST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at oss.nttdata.com MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit Date: Wed, 13 Sep 2023 21:40:46 +0900 From: torikoshia To: Peter Eisentraut Cc: Masahiro Ikeda , Pgsql Hackers Subject: Re: Make --help output fit within 80 columns per line In-Reply-To: <11f01df9-02ac-bc49-3f10-b7f2119ab7ce@eisentraut.org> References: <50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com> <3965013067e7b6195132da6c0b80a609@oss.nttdata.com> <70043684388c1a8d181cf8f3308ad3ec@oss.nttdata.com> <7ab6295d479544ae9acb926dc3e556cf@oss.nttdata.com> <11f01df9-02ac-bc49-3f10-b7f2119ab7ce@eisentraut.org> User-Agent: Roundcube Webmail/1.4.11 Message-ID: <3df2369f6002326ef057d88930f1adf4@oss.nttdata.com> X-Sender: torikoshia@oss.nttdata.com List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk 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