Re: [PATCH v4] checkout: add --progress option

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Nov 1, 2015, 20:15 UTC
Message-ID: <CAPig+cT-Mbf0cs+5OpPv+za=yrjiqycG5EtZONSrZwy8xL5pSA@mail.gmail.com>
In-Reply-To: <CAOc6etb24owGX1KD9b-eYt5TtTKzEzinvnJ-81ev5QK_tKgLPQ@mail.gmail.com>

On Sun, Nov 1, 2015 at 2:35 PM, Edmundo Carmona Antoranz <eantoranz@gmail.com> wrote:

Show 13 quoted lines

> On Sun, Nov 1, 2015 at 1:29 PM, Eric Sunshine <sunshine@sunshineco.com> wrote:
>>>> > +--progress::
>>>> > +       Progress status is reported on the standard error stream
>>>> > +       by default when it is attached to a terminal, unless -q
>>>> > +       is specified. This flag forces progress status even if the
>>>> > +       standard error stream is not directed to a terminal.
>
> Before I send a new full patch, could you guys tell me if you find this ok?
>
> -q::
> --quiet::
> Quiet, suppress feedback messages. Progress can skip this option.
> Read the information about --progress

IMHO, this sort of corner case probably doesn't deserve being called out specially. Also, since --progress immediately follows --quiet in the documentation, it's quite easy to discover --progress and read about its behavior. Thus, I'd leave the description of --quiet as is.

Show 6 quoted lines

> --[no-]progress::
> Progress status is reported on the standard error stream
> by default when it is attached to a terminal, unless --quiet
> or -q is specified. This flag forces progress status even if the
> standard error stream is not directed to a terminal and overrides
> the --quiet or -q options.

No need to make the description long by mentioning both -q and --quiet. (My v4 review suggested only that you quote -q or --quiet with backticks; not that you mention both.) The reader can easily discover the alias of -q or --quiet, so mentioning one or the other should be sufficient. A bit shorter and sweeter, perhaps:

    Progress status is reported on the standard error stream by
    default when it is attached to a terminal, unless `--quiet` is
    specified. This flag enables progress reporting even if not
    attached to a terminal, regardless of `--quiet`.