]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-130461: Remove unnecessary usages of `.. index::` directives in Doc/library/uuid...
authorKanishk Pachauri <itskanishkp.py@gmail.com>
Tue, 25 Feb 2025 12:27:50 +0000 (17:57 +0530)
committerGitHub <noreply@github.com>
Tue, 25 Feb 2025 12:27:50 +0000 (14:27 +0200)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Doc/library/uuid.rst
Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst [new file with mode: 0644]

index bff6b9dcdc57ca3729ae5d863a5f572d26d81ab3..c661fa2e52565c9ed6280c359850b3640ba927ba 100644 (file)
@@ -184,8 +184,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)
 
@@ -194,8 +192,6 @@ 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)
 
@@ -203,15 +199,11 @@ The :mod:`uuid` module defines the following functions:
    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)
 
@@ -219,8 +211,6 @@ The :mod:`uuid` module defines the following functions:
    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)
 
@@ -235,8 +225,6 @@ The :mod:`uuid` module defines the following functions:
 
    .. versionadded:: 3.14
 
-.. index:: single: uuid8
-
 
 The :mod:`uuid` module defines the following namespace identifiers for use with
 :func:`uuid3` or :func:`uuid5`.
diff --git a/Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst b/Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst
new file mode 100644 (file)
index 0000000..9e7e037
--- /dev/null
@@ -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.