[3.10] bpo-46120: State that `|` is preferred over `Union` (GH-30222) (GH-30250)

Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
(cherry picked from commit 1b30660c3b40da557050948ac8635f2dc50c4ee2)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Automerge-Triggered-By: GH:gpshead

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 3adb495ff7933483db53aadd4f2ceaaff8914a41..29bdb80ad22c688bc37f8730f8f672ab0121776c 100644 (file)
--- 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 (file)
index 0000000..17f6747
--- /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.