[Python-bugs-list] [ python-Bugs-458771 ] unittest things to be doc'd

noreply@sourceforge.net noreply@sourceforge.net
Thu, 06 Sep 2001 08:52:19 -0700


Bugs item #458771, was opened at 2001-09-05 08:49
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=458771&group_id=5470

Category: Documentation
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Rich Salz (rsalz)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: unittest things to be doc'd

Initial Comment:
We're starting to use the unittest module, and am
noticing some things that need documentation or doc
fixes.

TestSuite class: the run() method requires the result
object; unlike TestCase, it's not optional.

TestSuite objects "prefer" to be invoked by a test
runner (according to comments in the source); the run()
method of the TextTestRunner should be documented.  If
not, then TestSuite.__call__ needs to be changed to
make the result object optional.

I don't think the docs explain using the first line of
the docstring as the "short description" for tests.

TestLoader.loadTestFromName needs to define what a
"string specifier" is, as dis ltnNames. :)

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

>Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2001-09-06 08:52

Message:
Logged In: YES 
user_id=3066

The use of the docstring as a source for the short
description is explained in the docs for
TestCase.shortDescription().

I think I've addressed your other comments in
Doc/lib/libunittest.tex revision 1.6.

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

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