➜
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.
Created on 2021-08-16 13:22 by rittneje, last changed 2022-04-11 14:59 by admin. This issue is now closed.
| Pull Requests | |||
|---|---|---|---|
| URL | Status | Linked | Edit |
| PR 28004 | merged | DonnaDia, 2021-08-27 18:38 | |
| PR 28084 | merged | miss-islington, 2021-08-31 09:44 | |
| Messages (8) | |||
|---|---|---|---|
| msg399655 - (view) | Author: Jesse Rittner (rittneje) | Date: 2021-08-16 13:22 | |
The docs for typing.IO, typing.TextIO, and typing.BinaryIO include a confusing deprecation notice. https://docs.python.org/3/library/typing.html#typing.IO > Deprecated since version 3.8, will be removed in version 3.12: These types are also in the typing.io namespace, which was never supported by type checkers and will be removed. As per the discussion on https://github.com/python/typing/issues/834, this deprecation notice only refers to the typing.io package, which is confusing. It would be helpful to rephrase it for clarity. |
|||
| msg399658 - (view) | Author: Ken Jin (kj) *  |
Date: 2021-08-16 15:34 | |
@rittneje, would you like to submit a PR for this? We can help if you'd like to. |
|||
| msg399818 - (view) | Author: Jesse Rittner (rittneje) | Date: 2021-08-18 03:55 | |
@kj I'm not sure if I'll have the time, but for reference, is this what the PR would be raised against? https://raw.githubusercontent.com/python/cpython/main/Doc/library/typing.rst |
|||
| msg399831 - (view) | Author: Ken Jin (kj) * |
Date: 2021-08-18 10:17 | |
Yep! You can choose to add a new section under "Other concrete types", maybe "typing.io and typing.re submodules" then talk about how we could import from them in the past, but they're now deprecated and going to be removed. Alternatively, you can remove the existing notice, and just place a big note (..note::) underneath with the content above. > I'm not sure if I'll have the time No worries. We're not in a hurry. If you haven't checked it out already (and to save you some time) the devguide is here: https://devguide.python.org/pullrequest/#quick-guide You can probably skip some parts (like running tests) for a docs-only change. The main things are: 1. Please sign the CLA https://devguide.python.org/pullrequest/#licensing. 2. Make the change on main branch and send a PR over. We can review your changes once the PR is open. Thanks for your interest in contributing! (once again, no pressure, if you feel at any time you're too busy to take this up, it's perfectly okay). |
|||
| msg400437 - (view) | Author: Diana (DonnaDia) * | Date: 2021-08-27 18:25 | |
Hi, I can handle this. I will provide a pull request within 3 days. |
|||
| msg400702 - (view) | Author: Ken Jin (kj) * |
Date: 2021-08-31 09:44 | |
New changeset edae42f99f8153b92ccf365dbd1c2fa954f913b4 by DonnaDia in branch 'main': bpo-44925: [docs] Fix confusing deprecation notice for typing.IO (GH-28004) https://github.com/python/cpython/commit/edae42f99f8153b92ccf365dbd1c2fa954f913b4 |
|||
| msg400704 - (view) | Author: miss-islington (miss-islington) | Date: 2021-08-31 10:07 | |
New changeset 1d0c5596142eeb35fea172c3642e23aeca128f5d by Miss Islington (bot) in branch '3.10': bpo-44925: [docs] Fix confusing deprecation notice for typing.IO (GH-28004) https://github.com/python/cpython/commit/1d0c5596142eeb35fea172c3642e23aeca128f5d |
|||
| msg400705 - (view) | Author: Łukasz Langa (lukasz.langa) * |
Date: 2021-08-31 10:09 | |
Thanks for the report, Jesse, and Diana for the fix! ✨ 🍰 ✨ |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:59:48 | admin | set | github: 89088 |
| 2021-08-31 10:09:39 | lukasz.langa | set | status: open -> closed nosy: + lukasz.langa messages: + msg400705 resolution: fixed stage: patch review -> resolved |
| 2021-08-31 10:07:53 | miss-islington | set | messages: + msg400704 |
| 2021-08-31 09:44:39 | kj | set | messages: + msg400702 |
| 2021-08-31 09:44:37 | miss-islington | set | nosy:
+ miss-islington pull_requests: + pull_request26527 |
| 2021-08-27 18:38:09 | DonnaDia | set | keywords:
+ patch stage: patch review pull_requests: + pull_request26446 |
| 2021-08-27 18:25:38 | DonnaDia | set | nosy:
+ DonnaDia messages: + msg400437 |
| 2021-08-18 15:48:56 | JelleZijlstra | set | nosy:
+ JelleZijlstra |
| 2021-08-18 10:17:14 | kj | set | messages: + msg399831 |
| 2021-08-18 03:55:17 | rittneje | set | messages: + msg399818 |
| 2021-08-16 15:34:11 | kj | set | messages: + msg399658 |
| 2021-08-16 15:26:32 | kj | set | title: Confusing deprecation notice for typing.IO -> [docs] Confusing deprecation notice for typing.IO nosy: + srittau, kj, gvanrossum, docs@python assignee: docs@python versions: - Python 3.8 components: + Documentation, - Library (Lib) keywords: + easy, newcomer friendly |
| 2021-08-16 13:22:03 | rittneje | create | |