diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-05-04 09:17:35 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-04 09:17:35 (GMT) |
commit | 2046fb35e4e0986523bd0f6214fc318a414c8b97 (patch) | |
tree | 15c975520898ed9ab8e6e92e68d7123bf975f2fb | |
parent | 20380df6d819977882ed7d62784f207319f90865 (diff) | |
download | cpython-2046fb35e4e0986523bd0f6214fc318a414c8b97.zip cpython-2046fb35e4e0986523bd0f6214fc318a414c8b97.tar.gz cpython-2046fb35e4e0986523bd0f6214fc318a414c8b97.tar.bz2 |
bpo-44001: improve Literal documentation (GH-25877) (#25882)
(cherry picked from commit 87109f4d85c93a870ee8aa0d2b394547d4636b17)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
-rw-r--r-- | Doc/library/typing.rst | 4 | ||||
-rw-r--r-- | Doc/whatsnew/3.10.rst | 4 | ||||
-rw-r--r-- | Doc/whatsnew/3.9.rst | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 8b1ce34..ba79bb7 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -799,10 +799,10 @@ These can be used as types in annotations using ``[]``, each having a unique syn .. versionadded:: 3.8 .. versionchanged:: 3.9.1 - ``Literal`` now de-duplicates parameters. Equality comparison of + ``Literal`` now de-duplicates parameters. Equality comparisons of ``Literal`` objects are no longer order dependent. ``Literal`` objects will now raise a :exc:`TypeError` exception during equality comparisons - if one of their parameters are not :term:`immutable`. + if one of their parameters are not :term:`hashable`. .. data:: ClassVar diff --git a/Doc/whatsnew/3.10.rst b/Doc/whatsnew/3.10.rst index eb452b0..3d5a188 100644 --- a/Doc/whatsnew/3.10.rst +++ b/Doc/whatsnew/3.10.rst @@ -1271,8 +1271,8 @@ and to match the behavior of static type checkers specified in the PEP. now ``False``. To support this change, the internally used type cache now supports differentiating types. 4. ``Literal`` objects will now raise a :exc:`TypeError` exception during - equality comparisons if one of their parameters are not :term:`immutable`. - Note that declaring ``Literal`` with mutable parameters will not throw + equality comparisons if any of their parameters are not :term:`hashable`. + Note that declaring ``Literal`` with unhashable parameters will not throw an error:: >>> from typing import Literal diff --git a/Doc/whatsnew/3.9.rst b/Doc/whatsnew/3.9.rst index 772fb5a..f1725e7 100644 --- a/Doc/whatsnew/3.9.rst +++ b/Doc/whatsnew/3.9.rst @@ -1494,7 +1494,7 @@ and to match the behavior of static type checkers specified in the PEP. now ``False``. To support this change, the internally used type cache now supports differentiating types. 4. ``Literal`` objects will now raise a :exc:`TypeError` exception during - equality comparisons if one of their parameters are not :term:`immutable`. + equality comparisons if any of their parameters are not :term:`hashable`. Note that declaring ``Literal`` with mutable parameters will not throw an error:: |