git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH 3/3] t/README: clarify the test_have_prereq documentation
Date: Thu, 23 Mar 2017 17:59:32 -0700	[thread overview]
Message-ID: <20170324005932.GG20794@aiede.mtv.corp.google.com> (raw)
In-Reply-To: <20170322221854.10791-3-avarab@gmail.com>

Hi,

Ævar Arnfjörð Bjarmason wrote:

> --- 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.

  reply	other threads:[~2017-03-24  0:59 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-22 22:18 [PATCH 1/3] t/README: link to metacpan.org, not search.cpan.org Ævar Arnfjörð Bjarmason
2017-03-22 22:18 ` [PATCH 2/3] t/README: change "Inside <X> part" to "Inside the <X> part" Ævar Arnfjörð Bjarmason
2017-03-22 22:18 ` [PATCH 3/3] t/README: clarify the test_have_prereq documentation Ævar Arnfjörð Bjarmason
2017-03-24  0:59   ` Jonathan Nieder [this message]
2017-03-22 22:34 ` [PATCH 1/3] t/README: link to metacpan.org, not search.cpan.org Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170324005932.GG20794@aiede.mtv.corp.google.com \
    --to=jrnieder@gmail.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).