[ python-Bugs-1550263 ] Enhance and correct unittest's docs (redux)

[SourceForge.net]

Bugs item #1550263, was opened at 2006-09-01 02:02
Message generated for change (Comment added) made by gbrandl
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1550263&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: Python 2.4
>Status: Closed
Resolution: Accepted
Priority: 5
Private: No
Submitted By: Collin Winter (collinwinter)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Enhance and correct unittest's docs (redux)

Initial Comment:
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.

----------------------------------------------------------------------

>Comment By: Georg Brandl (gbrandl)
Date: 2007-03-07 11:38

Message:
Logged In: YES 
user_id=849994
Originator: NO

Now that there will be no 2.4.x anymore, closing again.

----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2006-09-01 04:02

Message:
Logged In: YES 
user_id=3066

Re-opening; these should be considered for Python 2.4.4 as well.

----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2006-09-01 03:58

Message:
Logged In: YES 
user_id=3066

Committed as revisions 51675 (Python 2.5) and 51676 (Python
2.6).  Anthony agreed that documentation improvements were
acceptable changes from 2.5 release candidate to 2.5 final.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1550263&group_id=5470