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: Document TestCase attributes in class docstring
Type: enhancement Stage: resolved
Components: Library (Lib) Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: Boris.FELD, djc, ezio.melotti, flub, python-dev
Priority: normal Keywords: patch

Created on 2010-06-05 12:30 by flub, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
unittest_docstring.patch Boris.FELD, 2011-12-18 13:06 Unittest TestCase docstring enhancement review
Messages (4)
msg107132 - (view) Author: Floris Bruynooghe (flub) Date: 2010-06-05 12:30
The unittest.TestCase class has some public attributes: failureException, longMessage and maxDiff.  They each have a description in a comment, but I think it would be good if that description got moved into the class docstring so that it would be found using help().
msg149751 - (view) Author: Boris FELD (Boris.FELD) * Date: 2011-12-18 13:06
Add a patch for this issue, move attributes comments in TestCase docstring.

I think it should be a good idea too to add their in unittest doc.
msg185478 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-03-29 01:44
New changeset 0753a663d27c by Ezio Melotti in branch '2.7':
#8906: document failureException, longMessage, and maxDiff in the class docstring.  Patch by Boris Feld.
http://hg.python.org/cpython/rev/0753a663d27c

New changeset b1c511418b29 by Ezio Melotti in branch '3.3':
#8906: document failureException, longMessage, and maxDiff in the class docstring.  Patch by Boris Feld.
http://hg.python.org/cpython/rev/b1c511418b29

New changeset 49cf8f656e9e by Ezio Melotti in branch 'default':
#8906: merge with 3.3.
http://hg.python.org/cpython/rev/49cf8f656e9e
msg185479 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-03-29 01:44
Fixed, thanks for the patch!
History
Date User Action Args
2022-04-11 14:57:01adminsetgithub: 53152
2013-03-29 01:44:42ezio.melottisetstatus: open -> closed
versions: + Python 3.3, Python 3.4, - Python 3.2
messages: + msg185479

assignee: ezio.melotti
resolution: fixed
stage: resolved
2013-03-29 01:44:07python-devsetnosy: + python-dev
messages: + msg185478
2011-12-18 13:06:39Boris.FELDsetfiles: + unittest_docstring.patch

nosy: + Boris.FELD
messages: + msg149751

keywords: + patch
2010-08-03 14:20:41djcsetnosy: + djc
2010-06-05 12:30:03flubcreate