GNU bug report logs - #13681
[patches] numfmt: standardize synopsis and docstring, and slice up helptext

Previous Next

Full log

Message #10 received at 13681-done <at> debbugs.gnu.org (full text, mbox):

From: Pádraig Brady <P <at> draigBrady.com>
To: Benno Schulenberg <bensberg <at> justemail.net>
Cc: 13681-done <at> debbugs.gnu.org
Subject: Re: bug#13681: [patches] numfmt: standardize synopsis and docstring, 
	and slice up helptext
Date: Sun, 10 Feb 2013 20:01:16 +0000

On 02/10/2013 07:10 PM, Benno Schulenberg wrote:
>
> Hi,
>
> The synopsis of numfmt currently says:
>
>    Usage: %s [OPTIONS] [NUMBER]
>
> But multiple numbers are allowed, and a single option too,
> so it should read:
>
>    Usage: %s [OPTION]... [NUMBER]...
>
> Further, the command description says:
>
>    Reformat NUMBER(s) from stdin or command arguments.
>
> This is double, because the NUMBER(s) already are the command
> arguments.  Furthermore, it is usual to refer to "standard input",
> in full, not with the abbreviation.
>
> Also, several of the option descriptions start with an uppercase
> letter, some not.  It is customary to start with a lowercase one,
> and also to not use a period at the end, and a semicolon if there
> is needed for multiple phrases.
>
> Since now all of the descriptions change, the attached patch
> takes the opportunity to slice the big help text (which is a
> nuisance for translators) into strings that encompass a single
> option.  (This follows the preference of the vast majority of
> translators.  Sami Kerola, who does a lot of work on util-linux,
> conducted a small but telling survey:
> http://www.spinics.net/lists/util-linux-ng/msg07489.html)

Thanks very much Benno.

I'll apply this for the upcoming release.

Pádraig.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.