Skip to content

Commit 73ab656

Browse files
authored
improve online docs
1 parent 2d917b0 commit 73ab656

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Doc/library/uuid.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010

1111
--------------
1212

13-
This module provides immutable :class:`UUID` objects (the :class:`UUID` class)
14-
and the functions :func:`uuid1`, :func:`uuid3`, :func:`uuid4`, :func:`uuid5`,
15-
:func:`uuid6`, :func:`uuid7`, and :func:`uuid8` for generating UUIDs version 1,
16-
3, 4, 5, 6, 7, and 8 as specified in :rfc:`9562` (which supersedes :rfc:`4122`).
13+
This module provides immutable :class:`UUID` objects (the :class:`UUID` class) and
14+
the :ref:`functions <uuid-constructor-functions>` for generating UUIDs corresponding
15+
to a specific UUID version as specified in :rfc:`9562` (which supersedes :rfc:`4122`),
16+
e.g., :func:`uuid1` for UUID version 1, :func:`uuid3` for UUID version 3, and so on.
17+
Note that UUID version 2 is deliberately omitted as it is outside the scope of the RFC.
1718

1819
If all you want is a unique ID, you should probably call :func:`uuid1` or
1920
:func:`uuid4`. Note that :func:`uuid1` may compromise privacy since it creates
@@ -185,6 +186,8 @@ The :mod:`uuid` module defines the following functions:
185186
globally unique, while the latter are not.
186187

187188

189+
.. _uuid-constructor-functions:
190+
188191
.. function:: uuid1(node=None, clock_seq=None)
189192

190193
Generate a UUID from a host ID, sequence number, and the current time. If *node*

0 commit comments

Comments
 (0)