Skip to content

Commit 34d8798

Browse files
committed
Merge branch 'ml/test-readme'
* ml/test-readme: t/README: unify documentation of test function args
2 parents 55a8607 + 72942a6 commit 34d8798

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

t/README

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ library for your script to use.
379379

380380
- test_expect_success [<prereq>] <message> <script>
381381

382-
Usually takes two strings as parameter, and evaluates the
382+
Usually takes two strings as parameters, and evaluates the
383383
<script>. If it yields success, test is considered
384384
successful. <message> should state what it is testing.
385385

@@ -390,7 +390,7 @@ library for your script to use.
390390
'tree=$(git-write-tree)'
391391

392392
If you supply three parameters the first will be taken to be a
393-
prerequisite, see the test_set_prereq and test_have_prereq
393+
prerequisite; see the test_set_prereq and test_have_prereq
394394
documentation below:
395395

396396
test_expect_success TTY 'git --paginate rev-list uses a pager' \
@@ -446,7 +446,7 @@ library for your script to use.
446446
Merges the given rev using the given message. Like test_commit,
447447
creates a tag and calls test_tick before committing.
448448

449-
- test_set_prereq SOME_PREREQ
449+
- test_set_prereq <prereq>
450450

451451
Set a test prerequisite to be used later with test_have_prereq. The
452452
test-lib will set some prerequisites for you, see the
@@ -456,7 +456,7 @@ library for your script to use.
456456
test_have_prereq directly, or the three argument invocation of
457457
test_expect_success and test_expect_failure.
458458

459-
- test_have_prereq SOME PREREQ
459+
- test_have_prereq <prereq>
460460

461461
Check if we have a prerequisite previously set with
462462
test_set_prereq. The most common use of this directly is to skip
@@ -526,12 +526,13 @@ library for your script to use.
526526

527527
Check whether a file has the length it is expected to.
528528

529-
- test_path_is_file <file> [<diagnosis>]
530-
test_path_is_dir <dir> [<diagnosis>]
529+
- test_path_is_file <path> [<diagnosis>]
530+
test_path_is_dir <path> [<diagnosis>]
531531
test_path_is_missing <path> [<diagnosis>]
532532

533-
Check whether a file/directory exists or doesn't. <diagnosis> will
534-
be displayed if the test fails.
533+
Check if the named path is a file, if the named path is a
534+
directory, or if the named path does not exist, respectively,
535+
and fail otherwise, showing the <diagnosis> text.
535536

536537
- test_when_finished <script>
537538

0 commit comments

Comments
 (0)