You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee='https://github.com/freddrake'closed_at=<Date2001-09-06.19:11:15.000>created_at=<Date2001-09-05.15:49:41.000>labels= ['docs']
title="unittest things to be doc'd"updated_at=<Date2001-09-06.19:11:15.000>user='https://bugs.python.org/rsalz'
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. :)
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" :)
Activity
rsalz commentedon Sep 5, 2001
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. :)
freddrake commentedon Sep 6, 2001
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.
rsalz commentedon Sep 6, 2001
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" :)
freddrake commentedon Sep 6, 2001
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.