Skip to content

Commit 85f1cc8

Browse files
pythongh-130461: Remove unnecessary usages of .. index:: directives in Doc/library/uuid.rst (python#130526)
Co-authored-by: Bénédikt Tran <[email protected]>
1 parent c1478d1 commit 85f1cc8

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

Doc/library/uuid.rst

-12
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,6 @@ The :mod:`uuid` module defines the following functions:
184184
administered MAC addresses, since the former are guaranteed to be
185185
globally unique, while the latter are not.
186186

187-
.. index:: single: getnode
188-
189187

190188
.. function:: uuid1(node=None, clock_seq=None)
191189

@@ -194,33 +192,25 @@ The :mod:`uuid` module defines the following functions:
194192
*clock_seq* is given, it is used as the sequence number; otherwise a random
195193
14-bit sequence number is chosen.
196194

197-
.. index:: single: uuid1
198-
199195

200196
.. function:: uuid3(namespace, name)
201197

202198
Generate a UUID based on the MD5 hash of a namespace identifier (which is a
203199
UUID) and a name (which is a :class:`bytes` object or a string
204200
that will be encoded using UTF-8).
205201

206-
.. index:: single: uuid3
207-
208202

209203
.. function:: uuid4()
210204

211205
Generate a random UUID.
212206

213-
.. index:: single: uuid4
214-
215207

216208
.. function:: uuid5(namespace, name)
217209

218210
Generate a UUID based on the SHA-1 hash of a namespace identifier (which is a
219211
UUID) and a name (which is a :class:`bytes` object or a string
220212
that will be encoded using UTF-8).
221213

222-
.. index:: single: uuid5
223-
224214

225215
.. function:: uuid8(a=None, b=None, c=None)
226216

@@ -235,8 +225,6 @@ The :mod:`uuid` module defines the following functions:
235225

236226
.. versionadded:: 3.14
237227

238-
.. index:: single: uuid8
239-
240228

241229
The :mod:`uuid` module defines the following namespace identifiers for use with
242230
:func:`uuid3` or :func:`uuid5`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Remove ``.. index::`` directives from the :mod:`uuid` module documentation. These directives
2+
previously created entries in the general index for :func:`~uuid.getnode` as well as the
3+
:func:`~uuid.uuid1`, :func:`~uuid.uuid3`, :func:`~uuid.uuid4`, :func:`~uuid.uuid5`, and
4+
:func:`~uuid.uuid8` constructor functions.

0 commit comments

Comments
 (0)