Add pointers to the original documentation from Test::More

[perl/modules/Test-Leaner.git] / lib / Test / Leaner.pm

diff --git a/lib/Test/Leaner.pm b/lib/Test/Leaner.pm
index 8a41e4e8ee39c3f6a424d0f929c62bef79c4c5af..b4416f819e7690f295a4a469c4f12ef4694e59d4 100644 (file)
--- a/lib/Test/Leaner.pm
+++ b/lib/Test/Leaner.pm
@@ -45,11 +45,21 @@ L</pass>, L</fail>, L</ok>, L</is>, L</isnt>, L</like>, L</unlike> and L</cmp_ok
 
 =item *
 
+L</like> and L</unlike> don't special case regular expressions that are passed as C<'/.../'> strings.
+A string regexp argument is always treated as a the source of the regexp, making C<like $text, $rx> and C<like $text, qr[$rx]> equivalent to each other and to C<cmp_ok $text, '=~', $rx> (and likewise for C<unlike>).
+
+=item *
+
 L</cmp_ok> throws an exception if the given operator isn't a valid Perl binary operator (except C<'='> and variants).
 It also tests in scalar context, so C<'..'> will be treated as the flip-flop operator and not the range operator.
 
 =item *
 
+L</is_deeply> doesn't guard for memory cycles.
+If the two first arguments present parallel memory cycles, the test may result in an infinite loop.
+
+=item *
+
 The tests don't output any kind of default diagnostic in case of failure ; the rationale being that if you have a large number of tests and a lot of them are failing, then you don't want to be flooded by diagnostics.
 
 =item *
@@ -127,6 +137,8 @@ The following functions from L<Test::More> are implemented and exported by defau
 
 =head2 C<< plan [ tests => $count | 'no_plan' | skip_all => $reason ] >>
 
+See L<Test::More/plan>.
+
 =cut
 
 sub plan {
@@ -226,6 +238,8 @@ sub import {
 
 =head2 C<< skip $reason => $count >>
 
+See L<Test::More/skip>.
+
 =cut
 
 sub skip {
@@ -261,6 +275,8 @@ sub skip {
 
 =head2 C<done_testing [ $count ]>
 
+See L<Test::More/done_testing>.
+
 =cut
 
 sub done_testing {
@@ -292,6 +308,8 @@ sub done_testing {
 
 =head2 C<ok $ok [, $desc ]>
 
+See L<Test::More/ok>.
+
 =cut
 
 sub ok ($;$) {
@@ -319,6 +337,8 @@ sub ok ($;$) {
 
 =head2 C<pass [ $desc ]>
 
+See L<Test::More/pass>.
+
 =cut
 
 sub pass (;$) {
@@ -328,6 +348,8 @@ sub pass (;$) {
 
 =head2 C<fail [ $desc ]>
 
+See L<Test::More/fail>.
+
 =cut
 
 sub fail (;$) {
@@ -337,6 +359,8 @@ sub fail (;$) {
 
 =head2 C<is $got, $expected [, $desc ]>
 
+See L<Test::More/is>.
+
 =cut
 
 sub is ($$;$) {
@@ -351,6 +375,8 @@ sub is ($$;$) {
 
 =head2 C<isnt $got, $expected [, $desc ]>
 
+See L<Test::More/isnt>.
+
 =cut
 
 sub isnt ($$;$) {
@@ -436,10 +462,12 @@ IS_BINOP
 
 =head2 C<like $got, $regexp_expected [, $desc ]>
 
-=cut
+See L<Test::More/like>.
 
 =head2 C<unlike $got, $regexp_expected, [, $desc ]>
 
+See L<Test::More/unlike>.
+
 =cut
 
 {
@@ -450,6 +478,8 @@ IS_BINOP
 
 =head2 C<cmp_ok $got, $op, $expected [, $desc ]>
 
+See L<Test::More/cmp_ok>.
+
 =cut
 
 sub cmp_ok ($$$;$) {
@@ -465,6 +495,8 @@ sub cmp_ok ($$$;$) {
 
 =head2 C<is_deeply $got, $expected [, $desc ]>
 
+See L<Test::More/is_deeply>.
+
 =cut
 
 sub _deep_check {
@@ -491,7 +523,9 @@ sub _deep_check {
 
  if ($ry eq 'ARRAY') {
   if ($#$x == $#$y) {
-   _deep_check($x->[$_], $y->[$_]) or return 0 for 0 .. $#$y;
+   # Prevent vivification of deleted elements by fetching the array values.
+   my ($ex, $ey);
+   _deep_check($ex = $x->[$_], $ey = $y->[$_]) or return 0 for 0 .. $#$y;
    return 1;
   }
  } elsif ($ry eq 'HASH') {
@@ -535,6 +569,8 @@ sub _diag_fh {
 
 =head2 C<diag @text>
 
+See L<Test::More/diag>.
+
 =cut
 
 sub diag {
@@ -544,6 +580,8 @@ sub diag {
 
 =head2 C<note @text>
 
+See L<Test::More/note>.
+
 =cut
 
 sub note {
@@ -553,6 +591,8 @@ sub note {
 
 =head2 C<BAIL_OUT [ $desc ]>
 
+See L<Test::More/BAIL_OUT>.
+
 =cut
 
 sub BAIL_OUT {