[debbugs-tracker] bug#13681: closed ([patches] numfmt: standardize synopsis and docstring, and slice up helptext)

[GNU bug Tracking System]

Your message dated Sun, 10 Feb 2013 20:01:16 +0000
with message-id <address@hidden>
and subject line Re: bug#13681: [patches] numfmt: standardize synopsis and 
docstring,  and slice up helptext
has caused the debbugs.gnu.org bug report #13681,
regarding [patches] numfmt: standardize synopsis and docstring, and slice up 
helptext
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
13681: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=13681
GNU Bug Tracking System
Contact address@hidden with problems

--- Begin Message --- Subject: [patches] numfmt: standardize synopsis and docstring, and slice up helptext Date: Sun, 10 Feb 2013 20:10:53 +0100

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)

Regards,

Benno

-- 
http://www.fastmail.fm - Does exactly what it says on the tin

0002-doc-standardize-the-synopsis-and-docstring-of-comman.patch
Description: Text Data

0003-doc-standardize-helptext-of-numfmt-and-slice-into-si.patch
Description: Text Data

--- End Message ---

> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#13681: [patches] numfmt: standardize synopsis and docstring, 	and slice up helptext
>
>
>
>
> Date: 
>
> Sun, 10 Feb 2013 20:01:16 +0000
>
>
>
>
> User-agent: 
>
> Mozilla/5.0 (X11; Linux x86_64;	rv:13.0) Gecko/20120615 Thunderbird/13.0.1
>
>
>
>
> 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.
>
>
> --- End Message ---