https://github.com/python/cpython/commit/f51a7483f5beaf48e62a1171557dcc9eca495517
commit: f51a7483f5beaf48e62a1171557dcc9eca495517
branch: 3.13
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: hugovk <1324225+hug...@users.noreply.github.com>
date: 2025-03-03T09:57:28Z
summary:
[3.13] gh-101100: Fix Sphinx documentation warnings in `collections.rst`
(GH-130629) (#130779)
gh-101100: Fix Sphinx documentation warnings in `collections.rst` (GH-130629)
(cherry picked from commit 373eb1b47af6843678c477b237d787c04dda2818)
Co-authored-by: Victorien <65306057+vii...@users.noreply.github.com>
files:
M Doc/library/collections.rst
M Doc/tools/.nitignore
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 5b4e445762e076..5fbdb12f40cafa 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -748,8 +748,8 @@ stack manipulations such as ``dup``, ``drop``, ``swap``,
``over``, ``pick``,
returns or raises is then returned or raised by
:meth:`~object.__getitem__`.
Note that :meth:`__missing__` is *not* called for any operations
besides
- :meth:`~object.__getitem__`. This means that :meth:`get` will, like
normal
- dictionaries, return ``None`` as a default rather than using
+ :meth:`~object.__getitem__`. This means that :meth:`~dict.get` will,
like
+ normal dictionaries, return ``None`` as a default rather than using
:attr:`default_factory`.
@@ -849,8 +849,9 @@ they add the ability to access fields by name instead of
position index.
Returns a new tuple subclass named *typename*. The new subclass is used to
create tuple-like objects that have fields accessible by attribute lookup
as
well as being indexable and iterable. Instances of the subclass also have
a
- helpful docstring (with typename and field_names) and a helpful
:meth:`__repr__`
- method which lists the tuple contents in a ``name=value`` format.
+ helpful docstring (with *typename* and *field_names*) and a helpful
+ :meth:`~object.__repr__` method which lists the tuple contents in a
``name=value``
+ format.
The *field_names* are a sequence of strings such as ``['x', 'y']``.
Alternatively, *field_names* can be a single string with each fieldname
@@ -894,10 +895,10 @@ they add the ability to access fields by name instead of
position index.
Added the *module* parameter.
.. versionchanged:: 3.7
- Removed the *verbose* parameter and the :attr:`_source` attribute.
+ Removed the *verbose* parameter and the :attr:`!_source` attribute.
.. versionchanged:: 3.7
- Added the *defaults* parameter and the :attr:`_field_defaults`
+ Added the *defaults* parameter and the
:attr:`~somenamedtuple._field_defaults`
attribute.
.. doctest::
@@ -1109,7 +1110,7 @@ Some differences from :class:`dict` still remain:
A regular :class:`dict` can emulate the order sensitive equality test with
``p == q and all(k1 == k2 for k1, k2 in zip(p, q))``.
-* The :meth:`popitem` method of :class:`OrderedDict` has a different
+* The :meth:`~OrderedDict.popitem` method of :class:`OrderedDict` has a
different
signature. It accepts an optional argument to specify which item is popped.
A regular :class:`dict` can emulate OrderedDict's ``od.popitem(last=True)``
@@ -1119,7 +1120,7 @@ Some differences from :class:`dict` still remain:
with ``(k := next(iter(d)), d.pop(k))`` which will return and remove the
leftmost (first) item if it exists.
-* :class:`OrderedDict` has a :meth:`move_to_end` method to efficiently
+* :class:`OrderedDict` has a :meth:`~OrderedDict.move_to_end` method to
efficiently
reposition an element to an endpoint.
A regular :class:`dict` can emulate OrderedDict's ``od.move_to_end(k,
@@ -1130,7 +1131,7 @@ Some differences from :class:`dict` still remain:
OrderedDict's ``od.move_to_end(k, last=False)`` which moves the key
and its associated value to the leftmost (first) position.
-* Until Python 3.8, :class:`dict` lacked a :meth:`__reversed__` method.
+* Until Python 3.8, :class:`dict` lacked a :meth:`~object.__reversed__` method.
.. class:: OrderedDict([items])
@@ -1185,7 +1186,7 @@ anywhere a regular dictionary is used.
.. versionchanged:: 3.6
With the acceptance of :pep:`468`, order is retained for keyword arguments
- passed to the :class:`OrderedDict` constructor and its :meth:`update`
+ passed to the :class:`OrderedDict` constructor and its :meth:`~dict.update`
method.
.. versionchanged:: 3.9
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 5ca21e1c7e36d9..805f047910a68f 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -16,7 +16,6 @@ Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.rst
Doc/library/asyncio-subprocess.rst
-Doc/library/collections.rst
Doc/library/decimal.rst
Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
