[issue11282] unittest document not keep consist with code
New submission from Ray.Allen ysj.ray@gmail.com:
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."
---------- assignee: docs@python components: Documentation messages: 129036 nosy: docs@python, ysj.ray priority: normal severity: normal status: open title: unittest document not keep consist with code versions: Python 3.3
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Changes by Ezio Melotti ezio.melotti@gmail.com:
---------- nosy: +ezio.melotti
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Changes by Ezio Melotti ezio.melotti@gmail.com:
---------- nosy: +michael.foord
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
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.
---------- nosy: +georg.brandl, terry.reedy stage: -> needs patch title: unittest document not keep consist with code -> 3.3 unittest document not kept consist with code
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Michael Foord michael@voidspace.org.uk added the comment:
Actually I think these methods are going back in and staying deprecated, so hold off for a bit.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Changes by Michael Foord michael@voidspace.org.uk:
---------- assignee: docs@python -> michael.foord
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Georg Brandl georg@python.org added the comment:
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 :)
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Changes by Arfrever Frehtes Taifersar Arahesis Arfrever.FTA@GMail.Com:
---------- nosy: +Arfrever
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Ezio Melotti ezio.melotti@gmail.com added the comment:
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?
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Michael Foord michael@voidspace.org.uk added the comment:
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.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Changes by Ezio Melotti ezio.melotti@gmail.com:
---------- assignee: michael.foord -> ezio.melotti
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Ezio Melotti ezio.melotti@gmail.com added the comment:
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.
---------- nosy: +gvanrossum, rhettinger
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Roundup Robot devnull@devnull added the comment:
New changeset 1fd736395df3 by Ezio Melotti in branch '3.2': #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': #11282: merge with 3.2. http://hg.python.org/cpython/rev/110bb604bc2f
New changeset aa658836e090 by Ezio Melotti in branch 'default': #11282: add back the fail* methods and assertDictContainsSubset. http://hg.python.org/cpython/rev/aa658836e090
---------- nosy: +python-dev
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
Changes by Ezio Melotti ezio.melotti@gmail.com:
---------- resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11282 _______________________________________
participants (7)
-
Arfrever Frehtes Taifersar Arahesis -
Ezio Melotti
-
Georg Brandl
-
Michael Foord
-
Ray.Allen
-
Roundup Robot
-
Terry J. Reedy