mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 18:59:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Improve version added references in typing module docs (GH-13457)

Browse source
This commit is contained in:
Anthony Sottile 2019-06-01 17:13:26 -07:00 • committed by Ivan Levkivskyi
parent b7fade4f87
commit b7daabd711
2 changed files with 19 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Doc/library/typing.rst
View file

@ -637,7 +637,7 @@ The module defines the following classes, functions and decorators:
A generic version of :class:`collections.abc.Collection` A generic version of :class:`collections.abc.Collection`
.. versionadded:: 3.6 .. versionadded:: 3.6.0
.. class:: AbstractSet(Sized, Collection[T_co]) .. class:: AbstractSet(Sized, Collection[T_co])
@ -681,6 +681,7 @@ The module defines the following classes, functions and decorators:
A generic version of :class:`collections.deque`. A generic version of :class:`collections.deque`.
.. versionadded:: 3.5.4
.. versionadded:: 3.6.1 .. versionadded:: 3.6.1
.. class:: List(list, MutableSequence[T]) .. class:: List(list, MutableSequence[T])
@ -730,6 +731,8 @@ The module defines the following classes, functions and decorators:
A generic version of :class:`collections.abc.Awaitable`. A generic version of :class:`collections.abc.Awaitable`.
.. versionadded:: 3.5.2
.. class:: Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co]) .. class:: Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co])
A generic version of :class:`collections.abc.Coroutine`. A generic version of :class:`collections.abc.Coroutine`.
@ -743,25 +746,33 @@ The module defines the following classes, functions and decorators:
async def bar() -> None: async def bar() -> None:
x = await c # type: int x = await c # type: int
.. versionadded:: 3.5.3
.. class:: AsyncIterable(Generic[T_co]) .. class:: AsyncIterable(Generic[T_co])
A generic version of :class:`collections.abc.AsyncIterable`. A generic version of :class:`collections.abc.AsyncIterable`.
.. versionadded:: 3.5.2
.. class:: AsyncIterator(AsyncIterable[T_co]) .. class:: AsyncIterator(AsyncIterable[T_co])
A generic version of :class:`collections.abc.AsyncIterator`. A generic version of :class:`collections.abc.AsyncIterator`.
.. versionadded:: 3.5.2
.. class:: ContextManager(Generic[T_co]) .. class:: ContextManager(Generic[T_co])
A generic version of :class:`contextlib.AbstractContextManager`. A generic version of :class:`contextlib.AbstractContextManager`.
.. versionadded:: 3.6 .. versionadded:: 3.5.4
.. versionadded:: 3.6.0
.. class:: AsyncContextManager(Generic[T_co]) .. class:: AsyncContextManager(Generic[T_co])
A generic version of :class:`contextlib.AbstractAsyncContextManager`. A generic version of :class:`contextlib.AbstractAsyncContextManager`.
.. versionadded:: 3.6 .. versionadded:: 3.5.4
.. versionadded:: 3.6.2
.. class:: Dict(dict, MutableMapping[KT, VT]) .. class:: Dict(dict, MutableMapping[KT, VT])
@ -790,12 +801,14 @@ The module defines the following classes, functions and decorators:
A generic version of :class:`collections.Counter`. A generic version of :class:`collections.Counter`.
.. versionadded:: 3.5.4
.. versionadded:: 3.6.1 .. versionadded:: 3.6.1
.. class:: ChainMap(collections.ChainMap, MutableMapping[KT, VT]) .. class:: ChainMap(collections.ChainMap, MutableMapping[KT, VT])
A generic version of :class:`collections.ChainMap`. A generic version of :class:`collections.ChainMap`.
.. versionadded:: 3.5.4
.. versionadded:: 3.6.1 .. versionadded:: 3.6.1
.. class:: Generator(Iterator[T_co], Generic[T_co, T_contra, V_co]) .. class:: Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])
@ -860,7 +873,7 @@ The module defines the following classes, functions and decorators:
yield start yield start
start = await increment(start) start = await increment(start)
.. versionadded:: 3.5.4 .. versionadded:: 3.6.1
.. class:: Text .. class:: Text
@ -1166,6 +1179,7 @@ The module defines the following classes, functions and decorators:
raise RuntimeError('no way') raise RuntimeError('no way')
.. versionadded:: 3.5.4 .. versionadded:: 3.5.4
.. versionadded:: 3.6.2
.. data:: Union .. data:: Union

1
Misc/NEWS.d/next/Documentation/2019-05-20-22-21-17.bpo-36984.IjZlmS.rst Normal file
View file

@ -0,0 +1 @@
Improve version added references in ``typing`` module - by Anthony Sottile.