Permalink
Browse files

Document how to turn details() and summary() on more clearly.

  • Loading branch information...
1 parent b6d95ad commit 5155d0863872c3a16118466c0d0b8053e4fd5ba0 @schwern schwern committed Apr 22, 2013
Showing with 9 additions and 5 deletions.
  1. +9 −5 lib/Test/Builder.pm
View
14 lib/Test/Builder.pm
@@ -1817,8 +1817,10 @@ This is a logical pass/fail, so todos are passes.
Of course, test #1 is $tests[0], etc...
-By default, this method will throw an exception unless Test::Builder has
-been configured to store events.
+By default, details are not stored and this method will throw an exception.
+To turn event storage on, set C<< Test::Builder->history->store_events(1) >>.
+However, please consider using the L<statistical methods of TB2::History|TB2::History/Statistics>
+instead as this will save memory and work.
=cut
@@ -1849,6 +1851,11 @@ sub name {
Like C<summary()>, but with a lot more detail.
+By default, details are not stored and this method will throw an exception.
+To turn event storage on, set C<< Test::Builder->history->store_events(1) >>.
+However, please consider using the L<statistical methods of TB2::History|TB2::History/Statistics>
+instead as this will save memory and work.
+
$tests[$test_num - 1] =
{ 'ok' => is the test considered a pass?
actual_ok => did it literally say 'ok'?
@@ -1890,9 +1897,6 @@ result in this structure:
reason => 'insufficient donuts'
};
-By default, this test will throw an exception unless Test::Builder has
-been configured to store events.
-
=cut
# Get $self->history->results and rethrow the error if results are

0 comments on commit 5155d08

Please sign in to comment.