Skip to content

Commit

Permalink
Document how to turn details() and summary() on more clearly.
Browse files Browse the repository at this point in the history
  • Loading branch information
schwern committed Apr 22, 2013
1 parent b6d95ad commit 5155d08
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions lib/Test/Builder.pm
Expand Up @@ -1817,8 +1817,10 @@ This is a logical pass/fail, so todos are passes.
Of course, test #1 is $tests[0], etc... Of course, test #1 is $tests[0], etc...
By default, this method will throw an exception unless Test::Builder has By default, details are not stored and this method will throw an exception.
been configured to store events. 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 =cut


Expand Down Expand Up @@ -1849,6 +1851,11 @@ sub name {
Like C<summary()>, but with a lot more detail. 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] = $tests[$test_num - 1] =
{ 'ok' => is the test considered a pass? { 'ok' => is the test considered a pass?
actual_ok => did it literally say 'ok'? actual_ok => did it literally say 'ok'?
Expand Down Expand Up @@ -1890,9 +1897,6 @@ result in this structure:
reason => 'insufficient donuts' reason => 'insufficient donuts'
}; };
By default, this test will throw an exception unless Test::Builder has
been configured to store events.
=cut =cut


# Get $self->history->results and rethrow the error if results are # Get $self->history->results and rethrow the error if results are
Expand Down

0 comments on commit 5155d08

Please sign in to comment.