[issue35631] Improve typing docs wrt abstract/concrete collection types
New submission from Ville Skyttä <ville.skytta@iki.fi>: 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. ---------- assignee: docs@python components: Documentation messages: 332842 nosy: docs@python, scop priority: normal severity: normal status: open title: Improve typing docs wrt abstract/concrete collection types type: enhancement _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by Ville Skyttä <ville.skytta@iki.fi>: ---------- keywords: +patch pull_requests: +10774 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by Ville Skyttä <ville.skytta@iki.fi>: ---------- keywords: +patch, patch pull_requests: +10774, 10775 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by Ville Skyttä <ville.skytta@iki.fi>: ---------- keywords: +patch, patch, patch pull_requests: +10774, 10775, 10776 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Ville Skyttä <ville.skytta@iki.fi> added the comment: (s/generic collection types/abstract collection types/ in the initial message) ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by Ivan Levkivskyi <levkivskyi@gmail.com>: ---------- nosy: +levkivskyi _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Ivan Levkivskyi <levkivskyi@gmail.com> added the comment: 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/31ec52a9afedd77e36a3ddc31c4c45664b8... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +10853 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +10853, 10854 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +10854, 10856 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +10856, 10857 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +10856, 10857, 10858 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +10853, 10854, 10855, 10856, 10857, 10858 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: 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/902196d867a34cc154fa9c861c883e69232... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
Ivan Levkivskyi <levkivskyi@gmail.com> added the comment: I think this can be closed now. Whether to merge doc-fix backport to now security-only 3.6 branch is up to Ned. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________
participants (3)
-
Ivan Levkivskyi -
miss-islington
-
Ville Skyttä