From ca9e52dac15d0da4d4ef57fb408565338da0bb40 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 18:55:20 +0530 Subject: [PATCH] [3.12] gh-130461: Remove unnecessary usages of `.. index::` directives in Doc/library/uuid.rst (#130526) (#130546) MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- Doc/library/uuid.rst | 9 --------- .../2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst | 4 ++++ 2 files changed, 4 insertions(+), 9 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 0f2d7820cb25..95f1176e7512 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -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) @@ -189,8 +187,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) @@ -198,15 +194,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) @@ -214,7 +206,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 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 index 000000000000..d28f71fc1b10 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst @@ -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`, and :func:`~uuid.uuid5` +constructor functions. -- 2.47.3