New submission from R. David Murray:
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.
---------- assignee: docs@python components: Documentation messages: 207178 nosy: docs@python, r.david.murray priority: normal severity: normal status: open title: TestProgram is mentioned in the unittest docs but is not documented versions: Python 2.7, Python 3.3, Python 3.4
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue20109 _______________________________________
Changes by Ezio Melotti ezio.melotti@gmail.com:
---------- nosy: +ezio.melotti, michael.foord type: -> enhancement
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue20109 _______________________________________
Tamás Bence Gedai added the comment:
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.
---------- nosy: +beng94
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue20109 _______________________________________
Michael Foord added the comment:
TestProgram is an abomination, but it has been publicly exposed in unittest since forever.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue20109 _______________________________________
-
Ezio Melotti -
Michael Foord
-
R. David Murray
-
Tamás Bence Gedai