classification
Title: TestProgram is mentioned in the unittest docs but is not documented
Type: enhancement Stage:
Components: Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: beng94, docs@python, ezio.melotti, michael.foord, r.david.murray
Priority: normal Keywords:

Created on 2014-01-02 18:01 by r.david.murray, last changed 2016-02-08 09:37 by michael.foord.

Messages (3)
msg207178 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-01-02 18:01
IMO, TestProgram should either be made anonymous in the docs ('main returns an object that has a results attribute...') or its external API should be formally documented.  If results is the only external API other than its init (which is documented as unittest.main), then I would suggest the former.  In either case exactly what 'results' contains should be clarified.
msg259728 - (view) Author: Tamás Bence Gedai (beng94) * Date: 2016-02-06 14:21
I think TestProgram should be anonymous, all the work is done in its constructor. I don't see why would anyone would call its functions. I can update the docs if it's needed.
msg259831 - (view) Author: Michael Foord (michael.foord) * (Python committer) Date: 2016-02-08 09:37
TestProgram is an abomination, but it has been publicly exposed in unittest since forever.
History
Date User Action Args
2016-02-08 09:37:54michael.foordsetmessages: + msg259831
2016-02-06 14:21:38beng94setnosy: + beng94
messages: + msg259728
2014-02-15 15:21:22ezio.melottisetnosy: + ezio.melotti, michael.foord
type: enhancement
2014-01-02 18:01:47r.david.murraycreate