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: Incorrect signature for unittest.TestResult.startTestRun(), .stopTestRun()
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: Volodymyr.Sapsai, docs@python, ezio.melotti, kushal.das, michael.foord, python-dev, terry.reedy
Priority: normal Keywords: patch

Created on 2014-04-07 14:39 by Volodymyr.Sapsai, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue21170.patch kushal.das, 2014-04-09 03:08 Fixes the documentation for unittest. review
Messages (4)
msg215710 - (view) Author: Volodymyr Sapsai (Volodymyr.Sapsai) Date: 2014-04-07 14:39
Steps to reproduce:
1. Open docs for unittest.TestResult class.
2. Look at startTestRun() and stopTestRun() methods signatures (https://docs.python.org/3.4/library/unittest.html#unittest.TestResult.startTestRun)

Actual result:
It is stated that aforementioned methods accept 1 argument 'test'.

Expected result:
These methods don't accept any arguments, it should be stated so in the docs.
msg215801 - (view) Author: Kushal Das (kushal.das) * (Python committer) Date: 2014-04-09 03:08
Here is a patch which fixes the documentation for unittest.
msg215939 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-04-11 17:57
Good catch. I verified in code that patch is correct.
msg215941 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-04-11 18:12
New changeset c1ea2846a564 by Terry Jan Reedy in branch '2.7':
Issue #21170: Removed invalid parameter names from unittest doc.
http://hg.python.org/cpython/rev/c1ea2846a564

New changeset 5734175a87d1 by Terry Jan Reedy in branch '3.4':
Issue #21170: Removed invalid parameter names from unittest doc.
http://hg.python.org/cpython/rev/5734175a87d1
History
Date User Action Args
2022-04-11 14:58:01adminsetgithub: 65369
2014-04-11 18:12:59terry.reedysetstatus: open -> closed
type: behavior
resolution: fixed
stage: patch review -> resolved
2014-04-11 18:12:10python-devsetnosy: + python-dev
messages: + msg215941
2014-04-11 17:57:22terry.reedysetassignee: docs@python -> terry.reedy

messages: + msg215939
nosy: + terry.reedy
2014-04-09 05:19:24berker.peksagsetnosy: + ezio.melotti, michael.foord
stage: patch review

versions: + Python 3.5
2014-04-09 03:08:03kushal.dassetfiles: + issue21170.patch

nosy: + kushal.das
messages: + msg215801

keywords: + patch
2014-04-07 14:39:19Volodymyr.Sapsaicreate