This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Improve typing docs wrt abstract/concrete collection types
Type: enhancement Stage: resolved
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, levkivskyi, miss-islington, scop
Priority: normal Keywords: patch, patch, patch

Created on 2019-01-01 07:35 by scop, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 11396 merged scop, 2019-01-01 07:37
PR 11396 merged scop, 2019-01-01 07:37
PR 11396 merged scop, 2019-01-01 07:37
PR 11431 merged miss-islington, 2019-01-04 14:14
PR 11431 merged miss-islington, 2019-01-04 14:15
PR 11431 merged miss-islington, 2019-01-04 14:15
PR 11432 closed miss-islington, 2019-01-04 14:15
PR 11432 closed miss-islington, 2019-01-04 14:15
PR 11432 closed miss-islington, 2019-01-04 14:15
Messages (5)
msg332842 - (view) Author: Ville Skyttä (scop) * Date: 2019-01-01 07:35
The typing docs for List includes a note to use generic collection types, but lists AbstractSet and Mapping which aren't generally replacements for a List. It would be better to remove those types from the List note and add corresponding ones to Dict and Set which are currently lacking it.

Additionally, some examples in the typing docs are in violation of the above stated preference, using Lists and Dicts as parameters.
msg332843 - (view) Author: Ville Skyttä (scop) * Date: 2019-01-01 07:58
(s/generic collection types/abstract collection types/ in the initial message)
msg332979 - (view) Author: Ivan Levkivskyi (levkivskyi) * (Python committer) Date: 2019-01-04 14:14
New changeset 31ec52a9afedd77e36a3ddc31c4c45664b8ac410 by Ivan Levkivskyi (Ville Skyttä) in branch 'master':
bpo-35631: Improve typing docs wrt abstract/concrete collection types (GH-11396)
https://github.com/python/cpython/commit/31ec52a9afedd77e36a3ddc31c4c45664b8ac410
msg332980 - (view) Author: miss-islington (miss-islington) Date: 2019-01-04 14:20
New changeset 902196d867a34cc154fa9c861c883e69232251c6 by Miss Islington (bot) in branch '3.7':
bpo-35631: Improve typing docs wrt abstract/concrete collection types (GH-11396)
https://github.com/python/cpython/commit/902196d867a34cc154fa9c861c883e69232251c6
msg332981 - (view) Author: Ivan Levkivskyi (levkivskyi) * (Python committer) Date: 2019-01-04 14:26
I think this can be closed now. Whether to merge doc-fix backport to now security-only 3.6 branch is up to Ned.
History
Date User Action Args
2022-04-11 14:59:09adminsetgithub: 79812
2019-01-04 14:26:42levkivskyisetstatus: open -> closed
messages: + msg332981

keywords: patch, patch, patch
resolution: fixed
stage: patch review -> resolved
2019-01-04 14:20:21miss-islingtonsetnosy: + miss-islington
messages: + msg332980
2019-01-04 14:15:31miss-islingtonsetpull_requests: + pull_request10855
2019-01-04 14:15:25miss-islingtonsetpull_requests: + pull_request10858
2019-01-04 14:15:18miss-islingtonsetpull_requests: + pull_request10857
2019-01-04 14:15:11miss-islingtonsetpull_requests: + pull_request10856
2019-01-04 14:15:05miss-islingtonsetpull_requests: + pull_request10854
2019-01-04 14:14:58miss-islingtonsetpull_requests: + pull_request10853
2019-01-04 14:14:36levkivskyisetmessages: + msg332979
2019-01-02 14:01:08levkivskyisetkeywords: patch, patch, patch
nosy: + levkivskyi
2019-01-01 07:58:02scopsetmessages: + msg332843
2019-01-01 07:37:47scopsetkeywords: + patch
stage: patch review
pull_requests: + pull_request10776
2019-01-01 07:37:42scopsetkeywords: + patch
stage: (no value)
pull_requests: + pull_request10775
2019-01-01 07:37:37scopsetkeywords: + patch
stage: (no value)
pull_requests: + pull_request10774
2019-01-01 07:35:43scopcreate