mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 12:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Document typing.NoReturn (GH-7107)

Browse source 
(cherry picked from commit 6e413f4327)

Co-authored-by: Ivan Levkivskyi <levkivskyi@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-05-24 21:51:14 -07:00 • committed by GitHub
parent 5734f41a9b
commit 82d727fce6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/typing.rst
View file

@ -937,6 +937,18 @@ The module defines the following classes, functions and decorators:
* Every type is compatible with :data:`Any`. * Every type is compatible with :data:`Any`.
* :data:`Any` is compatible with every type. * :data:`Any` is compatible with every type.
.. data:: NoReturn
Special type indicating that a function never returns.
For example::
from typing import NoReturn
def stop() -> NoReturn:
raise RuntimeError('no way')
.. versionadded:: 3.6.5
.. data:: Union .. data:: Union
Union type; ``Union[X, Y]`` means either X or Y. Union type; ``Union[X, Y]`` means either X or Y.