Skip to content

[3.13] gh-101100: Fix Sphinx documentation warnings in collections.rst (GH-130629) #130779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2025
Merged

[3.13] gh-101100: Fix Sphinx documentation warnings in collections.rst (GH-130629) #130779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions Doc/library/collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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)``
Expand All @@ -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,
Expand All @@ -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])
Expand Down Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading