From 2c6a053901cf468ad5b8d966d230a0d45a84f1e6 Mon Sep 17 00:00:00 2001 From: Nikita Sobolev Date: Sat, 25 Dec 2021 00:36:09 +0300 Subject: [PATCH] bpo-46120: State that `|` is preferred over `Union` (GH-30222) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Éric Co-authored-by: Guido van Rossum (cherry picked from commit 1b30660c3b40da557050948ac8635f2dc50c4ee2) Co-authored-by: Nikita Sobolev --- Doc/library/typing.rst | 2 +- .../next/Documentation/2021-12-21-12-45-57.bpo-46120.PE0DmJ.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 Misc/NEWS.d/next/Documentation/2021-12-21-12-45-57.bpo-46120.PE0DmJ.rst diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 3adb495ff79334..29bdb80ad22c68 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -625,7 +625,7 @@ These can be used as types in annotations using ``[]``, each having a unique syn Union type; ``Union[X, Y]`` is equivalent to ``X | Y`` and means either X or Y. - To define a union, use e.g. ``Union[int, str]`` or the shorthand ``int | str``. Details: + To define a union, use e.g. ``Union[int, str]`` or the shorthand ``int | str``. Using that shorthand is recommended. Details: * The arguments must be types and there must be at least one. diff --git a/Misc/NEWS.d/next/Documentation/2021-12-21-12-45-57.bpo-46120.PE0DmJ.rst b/Misc/NEWS.d/next/Documentation/2021-12-21-12-45-57.bpo-46120.PE0DmJ.rst new file mode 100644 index 00000000000000..17f67472e2ab02 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-12-21-12-45-57.bpo-46120.PE0DmJ.rst @@ -0,0 +1 @@ +State that ``|`` is preferred for readability over ``Union`` in the :mod:`typing` docs.