From dc6d1e30f1234d80c3fb9e09136ebde7928c6e04 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 17:57:50 +0530 Subject: [PATCH 1/3] gh-130461: Remove unnecessary usages of `.. index::` directives in Doc/library/uuid.rst (#130526) 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> (cherry picked from commit 85f1cc8d60b06d5b2af3e4da8e4f98171420dd91) --- Doc/library/uuid.rst | 23 +++++++++++-------- ...-02-25-03-53-00.gh-issue-130461.asr2dg.rst | 4 ++++ 2 files changed, 18 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 0f2d7820cb25c8..0f7d2e6d76023c 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,20 @@ 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) + + 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`. 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..9e7e0373ea43a4 --- /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`, :func:`~uuid.uuid5`, and +:func:`~uuid.uuid8` constructor functions. From 8ee3419a84b26bac68f40e408390d40eaf79e612 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 18:42:39 +0530 Subject: [PATCH 2/3] Update 2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst --- .../Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 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 9e7e0373ea43a4..d28f71fc1b1019 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,4 +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. +:func:`~uuid.uuid1`, :func:`~uuid.uuid3`, :func:`~uuid.uuid4`, and :func:`~uuid.uuid5` +constructor functions. From 0a1fdb74e88d3a97a3f85a4fb9179766ed431a43 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 25 Feb 2025 18:43:12 +0530 Subject: [PATCH 3/3] Update uuid.rst --- Doc/library/uuid.rst | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 0f7d2e6d76023c..95f1176e7512b8 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -207,20 +207,6 @@ The :mod:`uuid` module defines the following functions: that will be encoded using UTF-8). -.. 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`.