Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

3.3 unittest document not kept consist with code #55491

Closed
ysjray mannequin opened this issue Feb 22, 2011 · 8 comments
Closed

3.3 unittest document not kept consist with code #55491

ysjray mannequin opened this issue Feb 22, 2011 · 8 comments
Assignees
@ezio-melotti
Labels
docs Documentation in the Doc dir

Comments

@ysjray
Copy link
Mannequin

ysjray mannequin commented Feb 22, 2011

BPO 11282
Nosy @gvanrossum, @birkenfeld, @rhettinger, @terryjreedy, @ezio-melotti, @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-04-03.17:01:33.901>
created_at = <Date 2011-02-22.06:09:58.824>
labels = ['docs']
title = '3.3 unittest document not kept consist with code'
updated_at = <Date 2011-04-03.17:01:33.901>
user = 'https://bugs.python.org/ysjray'

bugs.python.org fields:

activity = <Date 2011-04-03.17:01:33.901>
actor = 'ezio.melotti'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2011-04-03.17:01:33.901>
closer = 'ezio.melotti'
components = ['Documentation']
creation = <Date 2011-02-22.06:09:58.824>
creator = 'ysj.ray'
dependencies = []
files = []
hgrepos = []
issue_num = 11282
keywords = []
message_count = 8.0
messages = ['129036', '129409', '129410', '129413', '130716', '130890', '132813', '132839']
nosy_count = 10.0
nosy_names = ['gvanrossum', 'georg.brandl', 'rhettinger', 'terry.reedy', 'ezio.melotti', 'Arfrever', 'michael.foord', 'ysj.ray', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue11282'
versions = ['Python 3.3']
@ysjray
Copy link
Mannequin Author

ysjray mannequin commented Feb 22, 2011

r88451:
Remove unittest methods scheduled for removal in 3.3

This commit remove assertSameElements() and assertDictContainsSubset(). But shouldn't some modification be done in the unittest library documentation? I wonder if we should remove the docs about the two methods. Now the doc only said "Deprecated since version 3.2."

@ysjray ysjray mannequin assigned docspython Feb 22, 2011
@ysjray ysjray mannequin added the docs Documentation in the Doc dir label Feb 22, 2011
@terryjreedy
Copy link
Member

Georg, what is policy on removed features?
Remove doc or leave and state removed?

"Deprecated in version 3.2 and removed in 3.3."
or just
"Removed in version 3.3"
(Once removed, does it really matter when deprecated?)

If left, should they be moved to separate section, especially when multiple? It could be a bit annoying for newcomers starting with 3.3 to read and struggle to understand and then read that they just wasted their time. There enough things already to learn and remember.

@terryjreedy terryjreedy changed the title unittest document not keep consist with code 3.3 unittest document not kept consist with code Feb 25, 2011
@voidspace
Copy link
Contributor

Actually I think these methods are going back in and staying deprecated, so hold off for a bit.

@voidspace voidspace assigned voidspace and unassigned docspython Feb 25, 2011
@birkenfeld
Copy link
Member

Removed things are also removed from the doc. I just committed as much as was necessary to stop buildbot breakage, and notified Michael to take care of the rest (which he did, by explaining I removed the wrong thing :)

@ezio-melotti
Copy link
Member

Michael, what's the status of this?
Do you think some of the removed methods should be added back even if they are marked as "removed in 3.3" in the 3.2 doc?

@voidspace
Copy link
Contributor

Those methods should *not* have been removed. I thought we had discussed this. It is my fault for allowing the error in the 3.2 docs to remain.

@ezio-melotti
Copy link
Member

Guido decided to leave the fail* methods and assertDictContainsSubset in 3.3 (and possibly even in the following versions), so that people moving from 2.7 to 3.3 don't have to change their code because these methods are missing.
Since assertSameElements is not in 2.7, it can be removed in 3.3.

I will therefore backout r88451 and add back the fail* methods and assertDictContainsSubset.

@python-dev
Copy link
Mannequin

python-dev mannequin commented Apr 3, 2011

New changeset 1fd736395df3 by Ezio Melotti in branch '3.2':
bpo-11282: the fail* methods will stay around a few more versions.
http://hg.python.org/cpython/rev/1fd736395df3

New changeset 110bb604bc2f by Ezio Melotti in branch 'default':
bpo-11282: merge with 3.2.
http://hg.python.org/cpython/rev/110bb604bc2f

New changeset aa658836e090 by Ezio Melotti in branch 'default':
bpo-11282: add back the fail* methods and assertDictContainsSubset.
http://hg.python.org/cpython/rev/aa658836e090

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ezio-melotti ezio-melotti

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@voidspace @birkenfeld @terryjreedy @ezio-melotti