8000 [3.12] gh-130461: Remove unnecessary usages of `.. index::` directive… · python/cpython@ca9e52d · GitHub
[go: up one dir, main page]

Skip to content

Commit ca9e52d

Browse files
Mr-Sunglassespicnixzhugovk
authored
[3.12] gh-130461: Remove unnecessary usages of .. index:: directives in Doc/library/uuid.rst (#130526) (#130546)
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>
1 parent b1a188a commit ca9e52d

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

Doc/library/uuid.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,6 @@ The :mod:`uuid` module defines the following functions:
179179
administered MAC addresses, since the former are guaranteed to be
180180
globally unique, while the latter are not.
181181

182-
.. index:: single: getnode
183-
184182

185183
.. function:: uuid1(node=None, clock_seq=None)
186184

@@ -189,32 +187,25 @@ The :mod:`uuid` module defines the following functions:
189187
*clock_seq* is given, it is used as the sequence number; otherwise a random
190188
14-bit sequence number is chosen.
191189

192-
.. index:: single: uuid1
193-
194190

195191
.. function:: uuid3(namespace, name)
196192

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

201-
.. index:: single: uuid3
202-
203197

204198
.. function:: uuid4()
205199

206200
Generate a random UUID.
207201

208-
.. index:: single: uuid4
209-
210202

211203
.. function:: uuid5(namespace, name)
212204

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

217-
.. index:: single: uuid5
218209

219210
The :mod:`uuid` module defines the following namespace identifiers for use with
220211
:func:`uuid3` or :func:`uuid5`.
Lines changed: 4 additions & 0 deletions
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`, and :func:`~uuid.uuid5`
4+
constructor functions.

0 commit comments

Comments
0