[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Clarification plan for apt-listbugs filtering options



Francesco Poli wrote:
[...]
>  * -S <state> | --stats <state>
> 
>   Filter bugs by pending-state, showing only the bugs matching a
>   specified value. List the pending-state categories that you want to
>   see, separated by commas and in the desired order. Default:
>   [forwarded,done,pending,pending-fixed]. Possible values are:

Oh, "in the desired order"!  Another esoteric feature; so the default
order is significant (and strange).  I wouldn't have been able to work
that out without your footnote; telling users to list filters "in the
desired order" is too close to telling them to list them "in whatever
order they like", and doesn't clearly imply that it affects the order
of the output.  I don't want to keep making this longer and longer;
maybe you could say:

    Filter (and sort) bugs by pending-state, showing only the bugs
    matching specified values. List the pending-state categories that
    you want to see, separated by commas and in the desired order.
    Default: [forwarded,done,pending,pending-fixed]. Possible values are:

[...]
> Second part (to be implemented after wheezy is out)
> ---------------------------------------------------
[...]
> Change the output of "apt-listbugs -h", so that it says:
> 
>  -s <severities>  : Filter bugs by severities you want to see (or "all")
>                     [critical,grave,serious].
>  -T <tags>        : Filter bugs by tags you want to see.
>  -S <state>       : Filter bugs by pending-state categories you want to see
>                     [pending,forwarded,pending-fixed,fixed,done].
>  -B <bug#>        : Filter bugs by number, showing only the specified bugs.

Should that be <states> plural?

Otherwise my only remaining concern there is a typographical nitpick -
anglophone styleguides don't approve of whitespace before colons,
which means we don't get to use that neat floating colon setup.  It
would have to be:

   -s <severities>: Filter bugs by severities you want to see (or "all")
                    [critical,grave,serious].
   -T <tags>:       Filter bugs by tags you want to see.
   -S <states>:     Filter bugs by pending-state categories you want to see
                    [pending,forwarded,pending-fixed,fixed,done].
   -B <bug#>:       Filter bugs by number, showing only the specified bugs.

(On the other hand, now that I'm used to it, I personally think the
floating-colon approach looks good, and it presumably means less work
for translators...)
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package


Reply to: