[Python-checkins] Document typing.NoReturn (GH-7107)
Miss Islington (bot)
webhook-mailer at python.org
Fri May 25 00:56:27 EDT 2018
https://github.com/python/cpython/commit/36f066a9747afdbc2e9376db90ae8d66399521ff
commit: 36f066a9747afdbc2e9376db90ae8d66399521ff
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-05-24T21:56:24-07:00
summary:
Document typing.NoReturn (GH-7107)
(cherry picked from commit 6e413f4327a68c4c7d62e0b6d0f9144be11dd6cd)
Co-authored-by: Ivan Levkivskyi <levkivskyi at gmail.com>
files:
M Doc/library/typing.rst
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 4a8f2f8e12e6..bd6f3a95fe62 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -938,6 +938,18 @@ The module defines the following classes, functions and decorators:
* Every type is compatible with :data:`Any`.
* :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
Union type; ``Union[X, Y]`` means either X or Y.
More information about the Python-checkins
mailing list