[Python-checkins] bpo-44001: improve Literal documentation (GH-25877)
ambv
webhook-mailer at python.org
Tue May 4 04:54:17 EDT 2021
https://github.com/python/cpython/commit/87109f4d85c93a870ee8aa0d2b394547d4636b17
commit: 87109f4d85c93a870ee8aa0d2b394547d4636b17
branch: main
author: Jelle Zijlstra <jelle.zijlstra at gmail.com>
committer: ambv <lukasz at langa.pl>
date: 2021-05-04T10:54:12+02:00
summary:
bpo-44001: improve Literal documentation (GH-25877)
files:
M Doc/library/typing.rst
M Doc/whatsnew/3.10.rst
M Doc/whatsnew/3.9.rst
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 8b1ce34d98ec66..ba79bb7ed75ff7 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 eb452b07f55f61..3d5a188625811e 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 772fb5a3fe7458..f1725e7df02204 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::
More information about the Python-checkins
mailing list