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: asyncio documentation does not mention provisional status
Type: Stage:
Components: asyncio, Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum, python-dev, takluyver, vstinner, yselivanov
Priority: normal Keywords:

Created on 2014-09-06 01:29 by takluyver, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (4)
msg226463 - (view) Author: Thomas Kluyver (takluyver) * Date: 2014-09-06 01:29
From PEP 411:

"""
A package will be marked provisional by a notice in its documentation page and its docstring. The following paragraph will be added as a note at the top of the documentation page:

    The <X> package has been included in the standard library on a provisional basis. Backwards incompatible changes (up to and including removal of the package) may occur if deemed necessary by the core developers.
"""

PEP 3156 says that asyncio is in provisional status until Python 3.5, but the main asyncio page in the docs does not even mention this, let alone having the new warning:
https://docs.python.org/3/library/asyncio.html

I freely admit this is nitpicking, but if the idea of provisional status is to be taken seriously, I think asyncio, as a very high profile new package, should set a good example of it.
msg226464 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-09-06 02:28
New changeset f8f3e83c9528 by Guido van Rossum in branch 'default':
Add PEP-411-compliant note about asyncio being provisional. Fixes issue #22346.
http://hg.python.org/cpython/rev/f8f3e83c9528
msg226465 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2014-09-06 02:29
Thanks!
msg226480 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-09-06 09:47
New changeset fefe7822e6b8 by Nick Coghlan in branch '3.4':
Issue #22346: also include asyncio PEP 411 notice in 3.4
http://hg.python.org/cpython/rev/fefe7822e6b8
History
Date User Action Args
2022-04-11 14:58:07adminsetgithub: 66542
2014-09-06 09:47:20python-devsetmessages: + msg226480
2014-09-06 02:29:20gvanrossumsetstatus: open -> closed
resolution: fixed
messages: + msg226465
2014-09-06 02:28:51python-devsetnosy: + python-dev
messages: + msg226464
2014-09-06 01:29:13takluyvercreate