]> granicus.if.org Git - python/commitdiff
bpo-37814: Document the empty tuple type annotation syntax (GH-15208)
authorJosh Holland <anowlcalledjosh@gmail.com>
Tue, 13 Aug 2019 19:05:09 +0000 (20:05 +0100)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 13 Aug 2019 19:05:09 +0000 (12:05 -0700)
https://bugs.python.org/issue37814:

> The empty tuple syntax in type annotations, `Tuple[()]`, is not obvious from the examples given in the documentation (I naively expected `Tuple[]` to work); it has been documented in PEP 484 and in mypy, but not in the documentation for the typing module.

https://bugs.python.org/issue37814

Doc/library/typing.rst

index d2dd03d50fc6e74dc734d5f05c96d225f54fb8c4..12efde1316570f32767a572d438ea34c2a01363c 100644 (file)
@@ -1245,7 +1245,8 @@ The module defines the following classes, functions and decorators:
 .. data:: Tuple
 
    Tuple type; ``Tuple[X, Y]`` is the type of a tuple of two items
-   with the first item of type X and the second of type Y.
+   with the first item of type X and the second of type Y. The type of
+   the empty tuple can be written as ``Tuple[()]``.
 
    Example: ``Tuple[T1, T2]`` is a tuple of two elements corresponding
    to type variables T1 and T2.  ``Tuple[int, float, str]`` is a tuple