Following up on SF #1534922 ("Cleanup/error-correction
for unittest's docs"), this patch adds the following
corrections and clairifications to Doc/lib/libunittest.tex:
1) Add language to the section on
TestLoader.loadTestsFromName() to make it explicit in
what order the "module/test case class/TestSuite
instance/test method within a test case class/callable
object which returns a TestCase or TestSuite instance"
tests are applied.
2) Add language to the section on
TestLoader.getTestCaseNames() to make it explicit that
the method's argument should be a subclass of TestCase.
3) Add language to the docs for TestCase.run() to
clairfying the relationship between TestCase.run() and
TestCase.defaultTestResult().
4) Better specify the purpose of
TestCase.defaultTestResult(). The previous docs were
vague and misleading.
5) Add language to the docs for the TestCase class that
better explains and illustrates the class's purpose and
usage. In particular, docs on the constructor's
optional ``methodName'' parameter were added; this
parameter was previously undocumented.
6) Add a brief mention of TestResult to the "Classes
and functions" section.
7) Add information on the default implementation of
several TestResult methods.
In addition, numerous smaller tweaks to grammar and
phrasing were made.
|