]> git.vpit.fr Git - perl/modules/Test-Leaner.git/blobdiff - README
Bump copyright year
[perl/modules/Test-Leaner.git] / README
diff --git a/README b/README
index f8fd072f072a967b7b4780a2286d7d4287571bb7..c888a55a762542b8c7ccde6a15162c9a50e0d1f7 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ NAME
     completeness.
 
 VERSION
-    Version 0.02
+    Version 0.05
 
 SYNOPSIS
         use Test::Leaner tests => 10_000;
@@ -25,15 +25,19 @@ DESCRIPTION
 
     *   Stringification isn't forced on the test operands. However, "ok"
         honors 'bool' overloading, "is" and "is_deeply" honor 'eq'
-        overloading (and just that one) and "cmp_ok" honors whichever
-        overloading category corresponds to the specified operator.
+        overloading (and just that one), "isnt" honors 'ne' overloading, and
+        "cmp_ok" honors whichever overloading category corresponds to the
+        specified operator.
 
-    *   "pass", "fail", "ok", "is", "isnt", "like", "unlike" and "cmp_ok"
-        are all guaranteed to return the truth value of the test.
+    *   "pass", "fail", "ok", "is", "isnt", "like", "unlike", "cmp_ok" and
+        "is_deeply" are all guaranteed to return the truth value of the
+        test.
+
+    *   "isn't" (the sub "t" in package "isn") is not aliased to "isnt".
 
     *   "like" and "unlike" don't special case regular expressions that are
         passed as '/.../' strings. A string regexp argument is always
-        treated as the source of the regexp, making "like $text, $rx" and
+        treated as the source of the regexp, making "like $text, $rx" and
         "like $text, qr[$rx]" equivalent to each other and to "cmp_ok $text,
         '=~', $rx" (and likewise for "unlike").
 
@@ -49,7 +53,8 @@ DESCRIPTION
     *   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.
+        flooded by diagnostics. Moreover, this allows a much faster variant
+        of "is_deeply".
 
     *   "use_ok", "require_ok", "can_ok", "isa_ok", "new_ok", "subtest",
         "explain", "TODO" blocks and "todo_skip" are not implemented.
@@ -58,8 +63,8 @@ ENVIRONMENT
   "PERL_TEST_LEANER_USES_TEST_MORE"
     If this environment variable is set, Test::Leaner will replace its
     functions by those from Test::More. Moreover, the symbols that are
-    imported you "use Test::Leaner" will be those from Test::More, but you
-    can still only import the symbols originally defined in Test::Leaner
+    imported when you "use Test::Leaner" will be those from Test::More, but
+    you can still only import the symbols originally defined in Test::Leaner
     (hence the functions from Test::More that are not implemented in
     Test::Leaner will not be imported). If your version of Test::More is too
     old and doesn't have some symbols (like "note" or "done_testing"), they
@@ -72,55 +77,101 @@ FUNCTIONS
     The following functions from Test::More are implemented and exported by
     default.
 
-  "plan [ tests => $count | 'no_plan' | skip_all => $reason ]"
+  "plan"
+        plan tests => $count;
+        plan 'no_plan';
+        plan skip_all => $reason;
+
     See "plan" in Test::More.
 
-  "skip $reason => $count"
+  "skip"
+        skip $reason => $count;
+
     See "skip" in Test::More.
 
-  "done_testing [ $count ]"
+  "done_testing"
+        done_testing;
+        done_testing $count;
+
     See "done_testing" in Test::More.
 
-  "ok $ok [, $desc ]"
+  "ok"
+        ok $ok;
+        ok $ok, $desc;
+
     See "ok" in Test::More.
 
-  "pass [ $desc ]"
+  "pass"
+        pass;
+        pass $desc;
+
     See "pass" in Test::More.
 
-  "fail [ $desc ]"
+  "fail"
+        fail;
+        fail $desc;
+
     See "fail" in Test::More.
 
-  "is $got, $expected [, $desc ]"
+  "is"
+        is $got, $expected;
+        is $got, $expected, $desc;
+
     See "is" in Test::More.
 
-  "isnt $got, $expected [, $desc ]"
+  "isnt"
+        isnt $got, $expected;
+        isnt $got, $expected, $desc;
+
     See "isnt" in Test::More.
 
-  "like $got, $regexp_expected [, $desc ]"
+  "like"
+        like $got, $regexp_expected;
+        like $got, $regexp_expected, $desc;
+
     See "like" in Test::More.
 
-  "unlike $got, $regexp_expected, [, $desc ]"
+  "unlike"
+        unlike $got, $regexp_expected;
+        unlike $got, $regexp_expected, $desc;
+
     See "unlike" in Test::More.
 
-  "cmp_ok $got, $op, $expected [, $desc ]"
+  "cmp_ok"
+        cmp_ok $got, $op, $expected;
+        cmp_ok $got, $op, $expected, $desc;
+
     See "cmp_ok" in Test::More.
 
-  "is_deeply $got, $expected [, $desc ]"
+  "is_deeply"
+        is_deeply $got, $expected;
+        is_deeply $got, $expected, $desc;
+
     See "is_deeply" in Test::More.
 
-  "diag @text"
+  "diag"
+        diag @lines;
+
     See "diag" in Test::More.
 
-  "note @text"
+  "note"
+        note @lines;
+
     See "note" in Test::More.
 
-  "BAIL_OUT [ $desc ]"
+  "BAIL_OUT"
+        BAIL_OUT;
+        BAIL_OUT $desc;
+
     See "BAIL_OUT" in Test::More.
 
     Test::Leaner also provides some functions of its own, which are never
     exported.
 
-  "tap_stream [ $fh ]"
+  "tap_stream"
+        my $tap_fh = tap_stream;
+        tap_stream $fh;
+
     Read/write accessor for the filehandle to which the tests are outputted.
     On write, it also turns autoflush on onto $fh.
 
@@ -129,7 +180,10 @@ FUNCTIONS
 
     Defaults to "STDOUT".
 
-  "diag_stream [ $fh ]"
+  "diag_stream"
+        my $diag_fh = diag_stream;
+        diag_stream $fh;
+
     Read/write accessor for the filehandle to which the diagnostics are
     printed. On write, it also turns autoflush on onto $fh.
 
@@ -168,7 +222,15 @@ SUPPORT
         perldoc Test::Leaner
 
 COPYRIGHT & LICENSE
-    Copyright 2010 Vincent Pit, all rights reserved.
+    Copyright 2010,2011,2013 Vincent Pit, all rights reserved.
+
+    This program is free software; you can redistribute it and/or modify it
+    under the same terms as Perl itself.
+
+    Except for the fallback implementation of the internal "_reftype"
+    function, which has been taken from Scalar::Util and is
+
+    Copyright 1997-2007 Graham Barr, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.