Issue 1550263: Enhance and correct unittest's docs (redux) (original) (raw)

Issue1550263

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/43918

classification

process

Created on 2006-09-01 02:02 by collinwinter, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (4)
msg29719 - (view)	Author: Collin Winter (collinwinter) *	Date: 2006-09-01 02:02
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.
msg29720 - (view)	Author: Fred Drake (fdrake)	Date: 2006-09-01 03:58
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.
msg29721 - (view)	Author: Fred Drake (fdrake)	Date: 2006-09-01 04:02
Logged In: YES user_id=3066 Re-opening; these should be considered for Python 2.4.4 as well.
msg29722 - (view)	Author: Georg Brandl (georg.brandl) *	Date: 2007-03-07 11:38
Now that there will be no 2.4.x anymore, closing again.