Skip to content

Commit 2f29a47

Browse files
stonedJJ
authored andcommitted
Rephrase descriptions
... to untie them from the parameters' names
1 parent c9eef1e commit 2f29a47

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

doc/Type/Test.pod6

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,8 @@ is-approx $value, $expected, :$abs-tol, :$rel-tol, 'test description';
268268
269269
=head3 Absolute tolerance
270270
271-
When an absolute tolerance is set, it's used as the actual maximum value by
272-
which the C<$value> and C<$expected> can differ. For example:
271+
When an absolute tolerance is set, it's used as the actual maximum value
272+
by which the first and the second parameters can differ. For example:
273273
274274
=begin code :preamble<use Test;>
275275
is-approx 3, 4, 2; # success
@@ -341,7 +341,7 @@ Defined as:
341341
multi sub is-deeply(Mu $got, Seq:D $expected, $reason = '')
342342
multi sub is-deeply(Mu $got, Mu $expected, $reason = '')
343343
344-
Marks a test as passed if C<$value> and C<$expected> are equivalent, using the
344+
Marks a test as passed if the first and second parameters are equivalent, using the
345345
same semantics as the L<eqv operator|/routine/eqv>. This is the best way to
346346
check for equality of (deep) data structures. The function accepts an optional
347347
description of the test as the last argument.
@@ -487,9 +487,10 @@ Use it this way:
487487
=for code :preamble<use Test;>
488488
like 'foo', /fo/, 'foo looks like fo';
489489
490-
Marks a test as passed if the C<$value>, when coerced to a string, matches the
491-
C<$expected-regex>. The function accepts an optional description of the
492-
test with a default value printing the expected match.
490+
Marks a test as passed if the first parameter when coerced to a string,
491+
matches the regular expression specified as the second parameter.
492+
The function accepts an optional description of the test with a default
493+
value printing the expected match.
493494
494495
=head2 sub unlike
495496
@@ -502,9 +503,10 @@ Used this way:
502503
=for code :preamble<use Test;>
503504
unlike 'foo', /bar/, 'foo does not look like bar';
504505
505-
Marks a test as passed if the C<$value>, when coerced to a string, does B<not>
506-
match the C<$expected-regex>. The function accepts an optional description
507-
of the test, which defaults to printing the text that did not match.
506+
Marks a test as passed if the first parameter, when coerced to a string,
507+
does B<not> match the regular expression specified as the second
508+
parameter. The function accepts an optional description of the test,
509+
which defaults to printing the text that did not match.
508510
509511
=head2 sub use-ok
510512

0 commit comments

Comments
 (0)