[docs] [issue22346] asyncio documentation does not mention provisional status

Thomas Kluyver report at bugs.python.org
Sat Sep 6 03:29:13 CEST 2014


New submission from Thomas Kluyver:

>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.

----------
assignee: docs at python
components: Documentation, asyncio
messages: 226463
nosy: docs at python, gvanrossum, haypo, takluyver, yselivanov
priority: normal
severity: normal
status: open
title: asyncio documentation does not mention provisional status
versions: Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue22346>
_______________________________________


More information about the docs mailing list