[Patches] [ python-Patches-1534922 ] Cleanup/error-correction for unittest's docs

[SourceForge.net]

Patches item #1534922, was opened at 2006-08-05 04:23
Message generated for change (Settings changed) made by gbrandl
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=1534922&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.5
>Status: Closed
>Resolution: Accepted
Priority: 5
Submitted By: Collin Winter (collinwinter)
Assigned to: Nobody/Anonymous (nobody)
Summary: Cleanup/error-correction for unittest's docs

Initial Comment:
The following patch, in addition to widespread typo and
grammar corrections and style improvements, fixes the
following errors/irritations:

* Removes a link to the PyUnit website (pyunit.sf.net)
and replaces use of the PyUnit name with unittest. The
module has not been known by this name for years.

* TextTestRunner is documented varyingly as printing to
stdout and stderr; the latter is correct. This is now
fixed.

* Several usages of the deprecated makeSuite() function
have been replaced with TestLoader()-based examples.

* One needlessly-complex TestSuite construction example
has been simplified to something understandable.

* It is stated that classes that implement TestCase's
interface can be used with unittest, even if they do
not subclass TestCase. This is false, contradicting
several other lines of documentation. Moreover, it does
not reflect reality: unittest relies heavily on
inheritance from TestCase to determine what is and what
is not a test case.

* It has now been made explicit which methods TestSuite
shares with TestCase. Previously, this had been left as
an exercise for the reader.

* TestLoader.loadTestsFromName() was not documented as
being able to handle a name that resolves to a
TestSuite. It can, and this capability is now documented.

* The documentation implied that
TestLoader.sortTestMethodsUsing affects only
TestLoader.getTestCaseNames(). This is inaccurate; it
is now explicit that it also affects all
TestLoader.loadTestsFrom*() methods.

* Make it explicit that TestLoader.suiteClass and
TestLoader.testMethodPrefix affect getTestCaseNames()
and all loadTestsFrom*() methods.

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

>Comment By: Georg Brandl (gbrandl)
Date: 2006-08-05 06:11

Message:
Logged In: YES 
user_id=849994

Thanks for the patch, I committed it almost unchanged as
rev. 51123.

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

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