[issue29481] 3.6.0 doc describes 3.6.1 feature - typing.Deque
New submission from Guy Arad: See: - https://docs.python.org/3.6/library/typing.html#typing.Deque - https://docs.python.org/3.5/library/typing.html#typing.Deque `typing.Deque` is expected to be included in 3.6.1: https://docs.python.org/3/whatsnew/changelog.html#python-3-6-1-release-candi... Please remove or specify the version in which it's going to be included. ---------- assignee: docs@python components: Documentation messages: 287313 nosy: Guy Arad, docs@python priority: normal severity: normal status: open title: 3.6.0 doc describes 3.6.1 feature - typing.Deque versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Raymond Hettinger <raymond.hettinger@gmail.com>: ---------- assignee: docs@python -> rhettinger nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Ivan Levkivskyi <levkivskyi@gmail.com>: ---------- nosy: +levkivskyi _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Terry J. Reedy added the comment: The online docs are regenerated daily from the current repository, so the inclusion of typing.Deque in the doc is correct, given that it has been added to the module. IDLE aside, new features in bugfix releases are limited to provisional modules, such as typing. I believe this should get a 'New in 3.6.1' (or 3.5.?) note. Some installations include a local frozen copy of the docs. The frozen copy will not include the rare (and admittedly confusing) feature added for a future release. But it will also not include the much more common corrections and clarifications added since the release. ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Thomas Caswell added the comment: I agree this is very confusing (and in fact confused me for about an hour between getting import errors, double checking the docs, checking I was in the right env, double checking the docs, checking the source of my env, double checking the docs, checking the git source and then tracking through these too issues). ---------- nosy: +tcaswell _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Thomas Caswell <tcaswell@gmail.com>: ---------- pull_requests: +50 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Raymond Hettinger added the comment: Yes, we should put versionadded in the docs to augment the MISC/NEWS entries. Mariatta, do you want to take a crack at the patch? It should hit both 3.5 and 3.6 docs. ---------- nosy: +Mariatta _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Mariatta Wijaya <mariatta.wijaya@gmail.com>: ---------- pull_requests: +70 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Mariatta Wijaya <mariatta.wijaya@gmail.com>: ---------- pull_requests: +71 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Mariatta Wijaya <mariatta.wijaya@gmail.com>: ---------- pull_requests: +72 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Mariatta Wijaya added the comment: Thanks, Raymond :) I prepared the pull requests for 3.5, 3.6, and master branches. Thomas, you mentioned about needing to go over CLA with your employer in your PR. Not sure if you have any update on that? If your CLA is approved, I can merge and cherry-pick your PR instead. ---------- stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Thomas Caswell added the comment: I am not optimistic about the speed at which my employer will get this sorted out. better to just fix it and drop my commit! On Tue, Feb 14, 2017, 23:43 Mariatta Wijaya <report@bugs.python.org> wrote: Mariatta Wijaya added the comment: Thanks, Raymond :) I prepared the pull requests for 3.5, 3.6, and master branches. Thomas, you mentioned about needing to go over CLA with your employer in your PR. Not sure if you have any update on that? If your CLA is approved, I can merge and cherry-pick your PR instead. ---------- stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________ ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Mariatta Wijaya added the comment: Thanks, Thomas :) I'll let you close your own PR on GitHub. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Mariatta Wijaya added the comment: New changeset 36da1c3589e1bc4246cccf6bd0094a110416a43a by GitHub in branch 'master': bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#107) https://github.com/python/cpython/commit/36da1c3589e1bc4246cccf6bd0094a11041... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Mariatta Wijaya added the comment: New changeset 7224a049b88ed37c510861528147e0db54911bb7 by GitHub in branch '3.6': bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#108) https://github.com/python/cpython/commit/7224a049b88ed37c510861528147e0db549... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Mariatta Wijaya added the comment: New changeset bb53a27a5d56a4f33c3fc8eebb486b34808c92b7 by GitHub in branch '3.5': [cherry-pick for 3.5] bpo-29481: add versionadded 3.5.4 to typing.Deque docs (#109) https://github.com/python/cpython/commit/bb53a27a5d56a4f33c3fc8eebb486b34808... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Mariatta Wijaya added the comment: Merged and backported to 3.5 and 3.6. Thanks all :) ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Nick Coghlan added the comment: New changeset 36da1c3589e1bc4246cccf6bd0094a110416a43a by GitHub in branch 'ncoghlan-devguide-link': bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#107) https://github.com/python/cpython/commit/36da1c3589e1bc4246cccf6bd0094a11041... ---------- nosy: +ncoghlan _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- Removed message: http://bugs.python.org/msg288060 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29481> _______________________________________
participants (8)
-
Ezio Melotti -
Guy Arad
-
Ivan Levkivskyi
-
Mariatta Wijaya
-
Nick Coghlan
-
Raymond Hettinger
-
Terry J. Reedy
-
Thomas Caswell