Repository navigation
Many references to unsupported Python versions in the stdlib docs #92417
Description
Documentation
There are currently many places in the stdlib docs where there are needless comments about how to maintain compatibility with Python versions that are now end-of-life. Many of these can now be removed, to improve brevity and clarity in the documentation.
I plan to submit a number of PRs to fix these.
PRs:
- gh-92417:
typingdocs:from __future__ import annotationscan be used in all supported Python versions #92418 - gh-92417:
asynciodocs:asyncio.run()is available on all supported Python versions #92419 - gh-92417:
doctestdocs: remove references to Python <3.6 #92420 - gh-92417:
fractions,decimal: Improve docs for alternative constructor methods #92421 - gh-92417:
jsondocs:dictis ordered on all supported Python versions #92422 - gh-92417:
stdtypesdocs: delete discussion of Python 2 differences #92423 - gh-92417:
importlibdocs: remove references to unsupported Python versions #92424 - gh-92417:
loggingdocs: Remove warning that only applies to Python <3.2 #92425 - gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for Py>=3 #92502
- gh-92417:
subprocessdocs: remove note on compatibility with Python <3.5 #92538 - gh-92417:
unittest.mockdocs: remove references to Python <2.6 #92539 - gh-92417:
zlibdocs,binasciidocs: remove Python 2 compatibility notes #92543 - gh-92417:
socketdocs: remove references to Python <3.3 #92544 - [More to come]
Backports:
- [3.11] gh-92417:
typingdocs:from __future__ import annotationscan be used in all supported Python versions (GH-92418) #92459 - [3.10] gh-92417:
typingdocs:from __future__ import annotationscan be used in all supported Python versions (GH-92418) #92460 - [3.9] gh-92417:
typingdocs:from __future__ import annotationscan be used in all supported Python versions (GH-92418) #92461 - [3.11] gh-92417:
asynciodocs:asyncio.run()is available on all supported Python versions (GH-92419) #92462 - [3.10] gh-92417:
asynciodocs:asyncio.run()is available on all supported Python versions (GH-92419) #92463 - [3.9] gh-92417:
asynciodocs:asyncio.run()is available on all supported Python versions (GH-92419) #92491 - [3.11] gh-92417:
doctestdocs: remove references to Python <3.6 (GH-92420) #92467 - [3.10] gh-92417:
doctestdocs: remove references to Python <3.6 (GH-92420) #92468 - [3.9] gh-92417:
doctestdocs: remove references to Python <3.6 (GH-92420) #92492 - [3.11] gh-92417:
jsondocs:dictis ordered on all supported Python versions (GH-92422) #92464 - [3.10] gh-92417:
jsondocs:dictis ordered on all supported Python versions (GH-92422) #92465 - [3.9] gh-92417:
jsondocs:dictis ordered on all supported Python versions (GH-92422) #92466 - [3.11] gh-92417:
stdtypesdocs: delete discussion of Python 2 differences (GH-92423) #92472 - [3.10] gh-92417:
stdtypesdocs: delete discussion of Python 2 differences (GH-92423) #92473 - [3.9] gh-92417:
stdtypesdocs: delete discussion of Python 2 differences (GH-92423) #92474 - [3.11] gh-92417:
loggingdocs: Remove warning that only applies to Python <3.2 (GH-92425) #92485 - [3.10] gh-92417:
loggingdocs: Remove warning that only applies to Python <3.2 (GH-92425) #92486 - [3.9] gh-92417:
loggingdocs: Remove warning that only applies to Python <3.2 (GH-92425) #92487 - [3.11] gh-92417:
unittest.mockdocs: remove references to Python <2.6 (GH-92539) #92606 - [3.11] gh-92417:
zlibdocs,binasciidocs: remove Python 2 compatibility notes (GH-92543) #92607
Activity
pythongh-92417: `typing` docs: `from __future__ import annotations` c…
pythongh-92417: `asyncio` docs: `asyncio.run()` is available on all s…
pythongh-92417: `doctest` docs: remove references to Python <3.6
pythongh-92417: `fractions` docs: remove references to Python <3.2
pythongh-92417: `json` docs: `dict` is ordered on all supported Pytho…
pythongh-92417: `stdtypes` docs: shorten discussion of Python 2 diffe…
pythongh-92417: `importlib` docs: remove references to unsupported Py…
pythongh-92417: `logging` docs: Remove warning that only applies to P…
gh-92417: `typing` docs: `from __future__ import annotations` can be …
pythongh-92417: `typing` docs: `from __future__ import annotations` c…
gh-92417: `asyncio` docs: `asyncio.run()` is available on all support…
pythongh-92417: `asyncio` docs: `asyncio.run()` is available on all s…
72 remaining items
pythongh-92417: `importlib` docs: remove references to unsupported Py…
gh-92417: `importlib` docs: remove references to unsupported Python v…
gh-92417: `subprocess` docs: remove note on compatibility with Python…
ambv commentedon May 19, 2022
I merged everything that was linked here. If all's done, this can be closed.
AlexWaygood commentedon May 19, 2022
Thank you for the reviews! This is now mostly done, but I think there's a few others left to do, so I'd rather keep it open for now. (I've been busy with other stuff lately.)
gh-92417: `subprocess` docs: remove note on compatibility with Python…
gh-92417: `importlib` docs: remove references to unsupported Python v…
pythongh-92417: `typing` docs: `from __future__ import annotations` c…
[3.9] pythongh-92417: `stdtypes` docs: delete discussion of Python 2 …
[3.9] pythongh-92417: `json` docs: `dict` is ordered on all supported…
pythongh-92417: `logging` docs: Remove warning that only applies to P…
pythongh-92417: `asyncio` docs: `asyncio.run()` is available on all s…
AlexWaygood commentedon Jul 25, 2022
This is basically done at this point, and I ran out of energy to finish the remaining bits that are left to do.