mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 16:39:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-46120: State that | is preferred over Union (GH-30222)

Browse source 
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
This commit is contained in:
Nikita Sobolev 2021-12-25 00:36:09 +03:00 • committed by GitHub
parent b8de8b7039
commit 1b30660c3b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/library/typing.rst
View file

@ -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.

1
Misc/NEWS.d/next/Documentation/2021-12-21-12-45-57.bpo-46120.PE0DmJ.rst Normal file
View file

@ -0,0 +1 @@
State that ``|`` is preferred for readability over ``Union`` in the :mod:`typing` docs.