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.

classification
Title: unittest things to be doc'd
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: fdrake Nosy List: fdrake, rsalz
Priority: normal Keywords:

Created on 2001-09-05 15:49 by rsalz, last changed 2022-04-10 16:04 by admin. This issue is now closed.

Messages (4)
msg6364 - (view) Author: Rich Salz (rsalz) Date: 2001-09-05 15:49
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. :)
msg6365 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2001-09-06 15:52
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.
msg6366 - (view) Author: Rich Salz (rsalz) Date: 2001-09-06 16:04
Logged In: YES 
user_id=36737

Looks good, except now you need to document makeSuite, in
particular that the 2nd string argument means "all functions
that start with this prefix are tests" :)
msg6367 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2001-09-06 19:11
Logged In: YES 
user_id=3066

makeSuite() should not be documented; it was marked obsolete
in the PyUnit sourcecode before it was accepted into the
standard library.
History
Date User Action Args
2022-04-10 16:04:24adminsetgithub: 35113
2001-09-05 15:49:41rsalzcreate