Re: [PATCH 3/3] t/README: clarify the test_have_prereq documentation

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Mar 24, 2017, 00:59 UTC
Message-ID: <20170324005932.GG20794@aiede.mtv.corp.google.com>
In-Reply-To: <20170322221854.10791-3-avarab@gmail.com>

Hi,

Ævar Arnfjörð Bjarmason wrote:

Show 12 quoted lines

> --- a/t/README
> +++ b/t/README
> @@ -612,8 +612,10 @@ library for your script to use.
>   - test_have_prereq <prereq>
>  
>     Check if we have a prerequisite previously set with
> -   test_set_prereq. The most common use of this directly is to skip
> -   all the tests if we don't have some essential prerequisite:
> +   test_set_prereq. The most common use-case for using this directly,
> +   as opposed to as an argument to test_expect_*, is to skip all the
> +   tests at the start of the test script if we don't have some
> +   essential prerequisite:

Nit: the hyphenated word "use-case" feels jargon-ish.  I've seen it
more often as two separate words.  Better yet to clarify that we're
talking about idioms and not just goals:

                       The most common way to use this explicitly (as opposed
      to the implicit use when an argument is passed to test_expect_*) is to
      skip all the tests at the start of a test script if we don't have some
      essential prerequisite:

With or without such a change,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.