mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

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

Browse source 
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>
This commit is contained in:
Kanishk Pachauri 2025-02-25 18:55:20 +05:30 • committed by GitHub
parent b1a188a7fa
commit ca9e52dac1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/uuid.rst
View file

@ -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`.

4
Misc/NEWS.d/next/Library/2025-02-25-03-53-00.gh-issue-130461.asr2dg.rst Normal file
View file

@ -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.