From: Ivan Levkivskyi Date: Fri, 25 May 2018 04:33:55 +0000 (-0700) Subject: Document typing.NoReturn (GH-7107) X-Git-Tag: v3.8.0a1~1762 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6e413f4327a68c4c7d62e0b6d0f9144be11dd6cd;p=thirdparty%2FPython%2Fcpython.git Document typing.NoReturn (GH-7107) --- diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index be6636eea08f..91d10e324cae 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -937,6 +937,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.