3.6.0 doc describes 3.6.1 feature - typing.Deque

[GuyArad]

BPO	29481
Nosy	@rhettinger, @terryjreedy, @ncoghlan, @ilevkivskyi, @tacaswell, @Mariatta
PRs	bpo-29481: DOC: mark which version typing.Deque added #61 bpo-29481: add versionadded 3.6.1 to typing.Deque docs #107 [cherry-pick for 3.6] bpo-29481: add versionadded 3.6.1 to typing.Deque docs #108 [cherry-pick for 3.5] bpo-29481: add versionadded 3.5.4 to typing.Deque docs #109

^{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/rhettinger'
closed_at = <Date 2017-02-15.19:41:12.396>
created_at = <Date 2017-02-08.12:53:06.192>
labels = ['docs']
title = '3.6.0 doc describes 3.6.1 feature - typing.Deque'
updated_at = <Date 2017-02-18.05:27:15.606>
user = 'https://bugs.python.org/GuyArad'

bugs.python.org fields:

activity = <Date 2017-02-18.05:27:15.606>
actor = 'ezio.melotti'
assignee = 'rhettinger'
closed = True
closed_date = <Date 2017-02-15.19:41:12.396>
closer = 'Mariatta'
components = ['Documentation']
creation = <Date 2017-02-08.12:53:06.192>
creator = 'Guy Arad'
dependencies = []
files = []
hgrepos = []
issue_num = 29481
keywords = []
message_count = 11.0
messages = ['287313', '287566', '287664', '287730', '287816', '287817', '287818', '287883', '287884', '287885', '287886']
nosy_count = 8.0
nosy_names = ['rhettinger', 'terry.reedy', 'ncoghlan', 'docs@python', 'levkivskyi', 'tcaswell', 'Mariatta', 'Guy Arad']
pr_nums = ['61', '107', '108', '109']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue29481'
versions = ['Python 3.5', 'Python 3.6']

[GuyArad]

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-candidate-1

Please remove or specify the version in which it's going to be included.

[terryjreedy]

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.

[tacaswell]

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).

[rhettinger]

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.

[Mariatta]

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.

[tacaswell]

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\>

---

[Mariatta]

Thanks, Thomas :) I'll let you close your own PR on GitHub.

[Mariatta]

New changeset 36da1c3 by GitHub in branch 'master':
bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#107)
36da1c3

[Mariatta]

New changeset 7224a04 by GitHub in branch '3.6':
bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#108)
7224a04

[Mariatta]

New changeset bb53a27 by GitHub in branch '3.5':
[cherry-pick for 3.5] bpo-29481: add versionadded 3.5.4 to typing.Deque docs (#109)
bb53a27

[Mariatta]

Merged and backported to 3.5 and 3.6.

Thanks all :)