Skip to content

[3.12] gh-130461: Remove unnecessary usages of .. index:: directives in Doc/library/uuid.rst (#130526) #130546

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 3 commits into from
Feb 25, 2025
Merged

[3.12] gh-130461: Remove unnecessary usages of .. index:: directives in Doc/library/uuid.rst (#130526) #130546

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b91f30e
gh-130461: Remove unnecessary usages of `.. index::` directives in Do…
Mr-Sunglasses Feb 25, 2025
2600c57
Update Doc/library/uuid.rst
Mr-Sunglasses Feb 25, 2025
d672fb3
Update Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.a…
Mr-Sunglasses Feb 25, 2025
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
22 changes: 13 additions & 9 deletions Doc/library/uuid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,6 @@ The :mod:`uuid` module defines the following functions:
administered MAC addresses, since the former are guaranteed to be
globally unique, while the latter are not.

.. index:: single: getnode


.. function:: uuid1(node=None, clock_seq=None)

Expand All @@ -189,32 +187,38 @@ The :mod:`uuid` module defines the following functions:
*clock_seq* is given, it is used as the sequence number; otherwise a random
14-bit sequence number is chosen.

.. index:: single: uuid1


.. function:: uuid3(namespace, name)

Generate a UUID based on the MD5 hash of a namespace identifier (which is a
UUID) and a name (which is a :class:`bytes` object or a string
that will be encoded using UTF-8).

.. index:: single: uuid3


.. function:: uuid4()

Generate a random UUID.

.. index:: single: uuid4


.. function:: uuid5(namespace, name)

Generate a UUID based on the SHA-1 hash of a namespace identifier (which is a
UUID) and a name (which is a :class:`bytes` object or a string
that will be encoded using UTF-8).

.. index:: single: uuid5
.. function:: uuid8(a=None, b=None, c=None)

Generate a pseudo-random UUID according to
:rfc:`RFC 9562, §5.8 <9562#section-5.8>`.

When specified, the parameters *a*, *b* and *c* are expected to be
positive integers of 48, 12 and 62 bits respectively. If they exceed
their expected bit count, only their least significant bits are kept;
non-specified arguments are substituted for a pseudo-random integer of
appropriate size.

.. versionadded:: 3.14


The :mod:`uuid` module defines the following namespace identifiers for use with
:func:`uuid3` or :func:`uuid5`.
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Remove ``.. index::`` directives from the :mod:`uuid` module documentation. These directives
previously created entries in the general index for :func:`~uuid.getnode` as well as the
:func:`~uuid.uuid1`, :func:`~uuid.uuid3`, :func:`~uuid.uuid4`, :func:`~uuid.uuid5`, and
:func:`~uuid.uuid8` constructor functions.
Loading