summaryrefslogtreecommitdiffstats
path: root/org/perl8/test/TestMore.html
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2013-03-01 14:44:07 -0600
committerJesse Luehrs <doy@tozt.net>2013-03-01 14:44:07 -0600
commitd756dfb61fbd78df938e8070be570eaa5aa9d610 (patch)
treed7faf66257a2a84c1de49de2168d1e06c4fc971f /org/perl8/test/TestMore.html
parentc26b0869a2b68d349eeb4baed11eaa2013b11f83 (diff)
downloadscala-test-more-d756dfb61fbd78df938e8070be570eaa5aa9d610.tar.gz
scala-test-more-d756dfb61fbd78df938e8070be570eaa5aa9d610.zip
doc updates
Diffstat (limited to 'org/perl8/test/TestMore.html')
-rw-r--r--org/perl8/test/TestMore.html16
1 files changed, 14 insertions, 2 deletions
diff --git a/org/perl8/test/TestMore.html b/org/perl8/test/TestMore.html
index 108ea08..2d86c14 100644
--- a/org/perl8/test/TestMore.html
+++ b/org/perl8/test/TestMore.html
@@ -568,7 +568,12 @@
</h4>
<p class="shortcomment cmt">Runs the test.</p><div class="fullcomment"><div class="comment cmt"><p>Runs the test. The TAP stream will be written to Console.out and
Console.err, so you can swap these out as required in order to parse it.
-</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div>
+</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>The exit code that the test produced. Success is indicated by 0,
+ failure to run the correct number of tests by 255, and any other
+ failure by the number of tests that failed. This should be used
+ by reporters which run a single test, which can call
+ <code>sys.exit(exitCode)</code>
+</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div>
</li><li name="org.perl8.test.Test#runInHarness" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="runInHarness:Int"></a>
<a id="runInHarness:Int"></a>
@@ -581,7 +586,14 @@ Console.err, so you can swap these out as required in order to parse it.
<span class="name">runInHarness</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4>
- <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div>
+ <p class="shortcomment cmt">Runs the test just like <a href="#run:Int" class="extmbr" name="org.perl8.test.TestMore#run">run</a>, but in a way that makes sense when test
+ results are being summarized rather than directly displayed.</p><div class="fullcomment"><div class="comment cmt"><p>Runs the test just like <a href="#run:Int" class="extmbr" name="org.perl8.test.TestMore#run">run</a>, but in a way that makes sense when test
+ results are being summarized rather than directly displayed.</p><p> Summarizing test reporters tend to repeatedly update the same line on
+ the terminal, so this method makes calls to
+ <a href="tap/TestBuilder.html#diag(message:String):Unit" class="extmbr" name="org.perl8.test.tap.TestBuilder#diag">diag</a> (which sends messages to
+ stderr, where they are typically displayed as-is) prefix the message
+ with a newline, to ensure that the output starts on its own line.
+</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="Test.html" class="extype" name="org.perl8.test.Test">Test</a></dd></dl></div>
</li><li name="org.perl8.test.TestMore#runTests" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="runTests(terminalInUse:Boolean):Int"></a>
<a id="runTests(Boolean):Int"></a>