From e6fd0d9d0e2c53a11954f0e6d8cbc09db23951e8 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 04:13:23 +0530 Subject: [PATCH 1/3] gh-130461: Remove unnecessary usages of `.. index::` directives in Doc/library/uuid.rst --- Doc/library/uuid.rst | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index bff6b9dcdc57ca..c661fa2e52565c 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -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`. From 113be97c9bed492611f0f619e9421c6313477857 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 04:14:05 +0530 Subject: [PATCH 2/3] chore: add NEWS entry for the change --- .../Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst 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 00000000000000..2ea7b63bb07c92 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst @@ -0,0 +1,3 @@ +* Removed ``.. index::`` directives from uuid module documentation. +* These directives previously created entries in the general index for functions ``getnode``, ``uuid1``, ``uuid3``, ``uuid4``, ``uuid5``, and ``uuid8``. +* This change affects the intersphinx inventory. (GH-130461) From a4e30c509682f77b0ff73aa6ccf9cd8101164c3e Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 04:33:24 +0530 Subject: [PATCH 3/3] chore: Update Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> --- .../Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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 index 2ea7b63bb07c92..9e7e0373ea43a4 100644 --- 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 @@ -1,3 +1,4 @@ -* Removed ``.. index::`` directives from uuid module documentation. -* These directives previously created entries in the general index for functions ``getnode``, ``uuid1``, ``uuid3``, ``uuid4``, ``uuid5``, and ``uuid8``. -* This change affects the intersphinx inventory. (GH-130461) +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.