Doc errors for unittest in Python 3.1

[voidspace]

BPO	11090
Nosy	@ezio-melotti, @merwok, @voidspace

^{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/ezio-melotti'
closed_at = <Date 2011-03-11.17:47:28.164>
created_at = <Date 2011-02-01.15:23:42.846>
labels = ['docs']
title = 'Doc errors for unittest in Python 3.1'
updated_at = <Date 2011-03-11.17:47:28.163>
user = 'https://github.com/voidspace'

bugs.python.org fields:

activity = <Date 2011-03-11.17:47:28.163>
actor = 'ezio.melotti'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2011-03-11.17:47:28.164>
closer = 'ezio.melotti'
components = ['Documentation']
creation = <Date 2011-02-01.15:23:42.846>
creator = 'michael.foord'
dependencies = []
files = []
hgrepos = []
issue_num = 11090
keywords = ['patch']
message_count = 6.0
messages = ['127703', '127779', '127780', '128074', '128086', '130597']
nosy_count = 4.0
nosy_names = ['ezio.melotti', 'eric.araujo', 'michael.foord', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue11090'
versions = ['Python 3.1']

[voidspace]

Looks like some unittest doc changes got incorrectly backported to Python 3.1.

For example the command line features using -m are new in 3.2 and don't work with 3.1:

http://docs.python.org/py3k/library/unittest.html#command-line-interface

[voidspace]

This incorrect section on unittest command line features was added by Eric according to svn blame.

[merwok]

Patch to remove the section about command-line usage + other things new in 3.2.

[merwok]

Hm, my patch removes too much. The part that was mistakenly added by me is the command-line interface doc, but I also removed other parts for things noted with versionadded: 3.2. Those indications are wrong: They were noted added in 2.7 before r79167 (Ezio).

[merwok]

It looks like the doc snippets are actually new in 3.1, so we should not remove them but just fix the versionadded.

The change I wrongly added is the part about command-line use. That can go.

[ezio-melotti]

addCleanup/doCleanups/startTestRun/stopTestRun are in 3.1 too and now they are documented as new in 3.1. I also removed the versionchanged note for __iter__ (0f9e5042907c).

Test discovery, --failfast, --catch, --buffer are new in 3.2 and not documented on 3.1.

This seems to be fixed now so I'm closing it, if I missed something feel free to reopen it.