summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-02-14 10:45:42 (GMT)
committerGitHub <noreply@github.com>2023-02-14 10:45:42 (GMT)
commit4aeae286715a3a9fa624429733582917606000c3 (patch)
tree5f9eb39a539ebc608e09cac967e44533b8d75bcd /Doc
parentfd155b91392c5bd238781bb11e040cf46c94725c (diff)
downloadcpython-4aeae286715a3a9fa624429733582917606000c3.zip
cpython-4aeae286715a3a9fa624429733582917606000c3.tar.gz
cpython-4aeae286715a3a9fa624429733582917606000c3.tar.bz2
GH-101898: Fix missing term references for hashable definition (GH-101899)
Fix missing term references for hashable definition (cherry picked from commit 3690688149dca11589af59b7704541336613199a) Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/dict.rst2
-rw-r--r--Doc/c-api/object.rst2
-rw-r--r--Doc/faq/programming.rst2
-rw-r--r--Doc/library/abc.rst2
-rw-r--r--Doc/library/collections.abc.rst4
-rw-r--r--Doc/library/collections.rst4
-rw-r--r--Doc/library/datetime.rst2
-rw-r--r--Doc/library/fractions.rst2
-rw-r--r--Doc/library/functools.rst2
-rw-r--r--Doc/library/graphlib.rst4
-rw-r--r--Doc/library/inspect.rst4
-rw-r--r--Doc/library/operator.rst2
-rw-r--r--Doc/library/pathlib.rst2
-rw-r--r--Doc/library/stdtypes.rst6
-rw-r--r--Doc/library/typing.rst2
-rw-r--r--Doc/reference/datamodel.rst2
16 files changed, 22 insertions, 22 deletions
diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst
index 819168d..be7b5f1 100644
--- a/Doc/c-api/dict.rst
+++ b/Doc/c-api/dict.rst
@@ -80,7 +80,7 @@ Dictionary Objects
.. c:function:: int PyDict_DelItem(PyObject *p, PyObject *key)
- Remove the entry in dictionary *p* with key *key*. *key* must be hashable;
+ Remove the entry in dictionary *p* with key *key*. *key* must be :term:`hashable`;
if it isn't, :exc:`TypeError` is raised.
If *key* is not in the dictionary, :exc:`KeyError` is raised.
Return ``0`` on success or ``-1`` on failure.
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 5a25a2b..84c72e7 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -281,7 +281,7 @@ Object Protocol
.. c:function:: Py_hash_t PyObject_HashNotImplemented(PyObject *o)
- Set a :exc:`TypeError` indicating that ``type(o)`` is not hashable and return ``-1``.
+ Set a :exc:`TypeError` indicating that ``type(o)`` is not :term:`hashable` and return ``-1``.
This function receives special treatment when stored in a ``tp_hash`` slot,
allowing a type to explicitly indicate to the interpreter that it is not
hashable.
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index ba42289..38f9b17 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -1979,7 +1979,7 @@ method result will be released right away. The disadvantage is that if
instances accumulate, so too will the accumulated method results. They
can grow without bound.
-The *lru_cache* approach works with methods that have hashable
+The *lru_cache* approach works with methods that have :term:`hashable`
arguments. It creates a reference to the instance unless special
efforts are made to pass in weak references.
diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst
index 3b74622..274b2d6 100644
--- a/Doc/library/abc.rst
+++ b/Doc/library/abc.rst
@@ -21,7 +21,7 @@ The :mod:`collections` module has some concrete classes that derive from
ABCs; these can, of course, be further derived. In addition, the
:mod:`collections.abc` submodule has some ABCs that can be used to test whether
a class or instance provides a particular interface, for example, if it is
-hashable or if it is a mapping.
+:term:`hashable` or if it is a mapping.
This module provides the metaclass :class:`ABCMeta` for defining ABCs and
diff --git a/Doc/library/collections.abc.rst b/Doc/library/collections.abc.rst
index 132b0ce..1ada0d3 100644
--- a/Doc/library/collections.abc.rst
+++ b/Doc/library/collections.abc.rst
@@ -22,7 +22,7 @@
This module provides :term:`abstract base classes <abstract base class>` that
can be used to test whether a class provides a particular interface; for
-example, whether it is hashable or whether it is a mapping.
+example, whether it is :term:`hashable` or whether it is a mapping.
An :func:`issubclass` or :func:`isinstance` test for an interface works in one
of three ways.
@@ -406,7 +406,7 @@ Notes on using :class:`Set` and :class:`MutableSet` as a mixin:
(3)
The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value
for the set; however, :meth:`__hash__` is not defined because not all sets
- are hashable or immutable. To add set hashability using mixins,
+ are :term:`hashable` or immutable. To add set hashability using mixins,
inherit from both :meth:`Set` and :meth:`Hashable`, then define
``__hash__ = Set._hash``.
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 2086383..285d362 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -25,7 +25,7 @@ Python's general purpose built-in containers, :class:`dict`, :class:`list`,
:func:`namedtuple` factory function for creating tuple subclasses with named fields
:class:`deque` list-like container with fast appends and pops on either end
:class:`ChainMap` dict-like class for creating a single view of multiple mappings
-:class:`Counter` dict subclass for counting hashable objects
+:class:`Counter` dict subclass for counting :term:`hashable` objects
:class:`OrderedDict` dict subclass that remembers the order entries were added
:class:`defaultdict` dict subclass that calls a factory function to supply missing values
:class:`UserDict` wrapper around dictionary objects for easier dict subclassing
@@ -241,7 +241,7 @@ For example::
.. class:: Counter([iterable-or-mapping])
- A :class:`Counter` is a :class:`dict` subclass for counting hashable objects.
+ A :class:`Counter` is a :class:`dict` subclass for counting :term:`hashable` objects.
It is a collection where elements are stored as dictionary keys
and their counts are stored as dictionary values. Counts are allowed to be
any integer value including zero or negative counts. The :class:`Counter`
diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst
index c7b9667..443d80c 100644
--- a/Doc/library/datetime.rst
+++ b/Doc/library/datetime.rst
@@ -160,7 +160,7 @@ The :class:`date`, :class:`.datetime`, :class:`.time`, and :class:`timezone` typ
share these common features:
- Objects of these types are immutable.
-- Objects of these types are hashable, meaning that they can be used as
+- Objects of these types are :term:`hashable`, meaning that they can be used as
dictionary keys.
- Objects of these types support efficient pickling via the :mod:`pickle` module.
diff --git a/Doc/library/fractions.rst b/Doc/library/fractions.rst
index 5f0ecf1..85bec73 100644
--- a/Doc/library/fractions.rst
+++ b/Doc/library/fractions.rst
@@ -77,7 +77,7 @@ another rational number, or from a string.
The :class:`Fraction` class inherits from the abstract base class
:class:`numbers.Rational`, and implements all of the methods and
- operations from that class. :class:`Fraction` instances are hashable,
+ operations from that class. :class:`Fraction` instances are :term:`hashable`,
and should be treated as immutable. In addition,
:class:`Fraction` has the following properties and methods:
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 2f0a9bd..80a405e 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -147,7 +147,7 @@ The :mod:`functools` module defines the following functions:
threads.
Since a dictionary is used to cache results, the positional and keyword
- arguments to the function must be hashable.
+ arguments to the function must be :term:`hashable`.
Distinct argument patterns may be considered to be distinct calls with
separate cache entries. For example, ``f(a=1, b=2)`` and ``f(b=2, a=1)``
diff --git a/Doc/library/graphlib.rst b/Doc/library/graphlib.rst
index 2bc80da..fe7932e 100644
--- a/Doc/library/graphlib.rst
+++ b/Doc/library/graphlib.rst
@@ -17,7 +17,7 @@
.. class:: TopologicalSorter(graph=None)
- Provides functionality to topologically sort a graph of hashable nodes.
+ Provides functionality to topologically sort a graph of :term:`hashable` nodes.
A topological order is a linear ordering of the vertices in a graph such that
for every directed edge u -> v from vertex u to vertex v, vertex u comes
@@ -85,7 +85,7 @@
.. method:: add(node, *predecessors)
Add a new node and its predecessors to the graph. Both the *node* and all
- elements in *predecessors* must be hashable.
+ elements in *predecessors* must be :term:`hashable`.
If called multiple times with the same node argument, the set of
dependencies will be the union of all dependencies passed in.
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 9cb7a6f..6a696c9 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -668,7 +668,7 @@ function.
modified copy.
.. versionchanged:: 3.5
- Signature objects are picklable and hashable.
+ Signature objects are picklable and :term:`hashable`.
.. attribute:: Signature.empty
@@ -746,7 +746,7 @@ function.
you can use :meth:`Parameter.replace` to create a modified copy.
.. versionchanged:: 3.5
- Parameter objects are picklable and hashable.
+ Parameter objects are picklable and :term:`hashable`.
.. attribute:: Parameter.empty
diff --git a/Doc/library/operator.rst b/Doc/library/operator.rst
index 35e9b49..6d90473 100644
--- a/Doc/library/operator.rst
+++ b/Doc/library/operator.rst
@@ -327,7 +327,7 @@ expect a function argument.
return g
The items can be any type accepted by the operand's :meth:`__getitem__`
- method. Dictionaries accept any hashable value. Lists, tuples, and
+ method. Dictionaries accept any :term:`hashable` value. Lists, tuples, and
strings accept an index or a slice:
>>> itemgetter(1)('ABCDEFG')
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index e8bb00f..abdeea2 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -186,7 +186,7 @@ these classes, since they don't provide any operation that does system calls.
General properties
^^^^^^^^^^^^^^^^^^
-Paths are immutable and hashable. Paths of a same flavour are comparable
+Paths are immutable and :term:`hashable`. Paths of a same flavour are comparable
and orderable. These properties respect the flavour's case-folding
semantics::
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 2bc86e9..1563c4d 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -3765,7 +3765,7 @@ copying.
>>> data
bytearray(b'z1spam')
- One-dimensional memoryviews of hashable (read-only) types with formats
+ One-dimensional memoryviews of :term:`hashable` (read-only) types with formats
'B', 'b' or 'c' are also hashable. The hash is defined as
``hash(m) == hash(m.tobytes())``::
@@ -3779,7 +3779,7 @@ copying.
.. versionchanged:: 3.3
One-dimensional memoryviews can now be sliced.
- One-dimensional memoryviews with formats 'B', 'b' or 'c' are now hashable.
+ One-dimensional memoryviews with formats 'B', 'b' or 'c' are now :term:`hashable`.
.. versionchanged:: 3.4
memoryview is now registered automatically with
@@ -4699,7 +4699,7 @@ support membership tests:
.. versionadded:: 3.10
-Keys views are set-like since their entries are unique and hashable. If all
+Keys views are set-like since their entries are unique and :term:`hashable`. If all
values are hashable, so that ``(key, value)`` pairs are unique and hashable,
then the items view is also set-like. (Values views are not treated as set-like
since the entries are generally not unique.) For set-like views, all of the
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 7fc0aa3..b08977e 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -439,7 +439,7 @@ are intended primarily for static type checking.
A user-defined generic class can have ABCs as base classes without a metaclass
conflict. Generic metaclasses are not supported. The outcome of parameterizing
-generics is cached, and most types in the typing module are hashable and
+generics is cached, and most types in the typing module are :term:`hashable` and
comparable for equality.
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index afd4a54..dce48a4 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1525,7 +1525,7 @@ Basic customization
:meth:`__hash__`, its instances will not be usable as items in hashable
collections. If a class defines mutable objects and implements an
:meth:`__eq__` method, it should not implement :meth:`__hash__`, since the
- implementation of hashable collections requires that a key's hash value is
+ implementation of :term:`hashable` collections requires that a key's hash value is
immutable (if the object's hash value changes, it will be in the wrong hash
bucket).