From fa50342d91ab9b122611808ff521feceb5fde1fb Mon Sep 17 00:00:00 2001 From: sobolevn Date: Sat, 2 Sep 2023 11:28:22 +0300 Subject: [PATCH 1/2] gh-101100: Fix sphinx warnings in `uuid.rst` --- Doc/library/uuid.rst | 42 +++++++++++++++++++++--------------------- Doc/tools/.nitignore | 1 - 2 files changed, 21 insertions(+), 22 deletions(-) diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 94b9a432372195..05b345de9cc6eb 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -22,7 +22,7 @@ random UUID. Depending on support from the underlying platform, :func:`uuid1` may or may not return a "safe" UUID. A safe UUID is one which is generated using synchronization methods that ensure no two processes can obtain the same -UUID. All instances of :class:`UUID` have an :attr:`is_safe` attribute +UUID. All instances of :class:`UUID` have an :attr:`~UUID.is_safe` attribute which relays any information about the UUID's safety, using this enumeration: .. class:: SafeUUID @@ -95,25 +95,25 @@ which relays any information about the UUID's safety, using this enumeration: A tuple of the six integer fields of the UUID, which are also available as six individual attributes and two derived attributes: - +------------------------------+-------------------------------+ - | Field | Meaning | - +==============================+===============================+ - | :attr:`time_low` | the first 32 bits of the UUID | - +------------------------------+-------------------------------+ - | :attr:`time_mid` | the next 16 bits of the UUID | - +------------------------------+-------------------------------+ - | :attr:`time_hi_version` | the next 16 bits of the UUID | - +------------------------------+-------------------------------+ - | :attr:`clock_seq_hi_variant` | the next 8 bits of the UUID | - +------------------------------+-------------------------------+ - | :attr:`clock_seq_low` | the next 8 bits of the UUID | - +------------------------------+-------------------------------+ - | :attr:`node` | the last 48 bits of the UUID | - +------------------------------+-------------------------------+ - | :attr:`time` | the 60-bit timestamp | - +------------------------------+-------------------------------+ - | :attr:`clock_seq` | the 14-bit sequence number | - +------------------------------+-------------------------------+ + +-------------------------------+-------------------------------+ + | Field | Meaning | + +===============================+===============================+ + | :attr:`!time_low` | the first 32 bits of the UUID | + +-------------------------------+-------------------------------+ + | :attr:`!time_mid` | the next 16 bits of the UUID | + +-------------------------------+-------------------------------+ + | :attr:`!time_hi_version` | the next 16 bits of the UUID | + +-------------------------------+-------------------------------+ + | :attr:`!clock_seq_hi_variant` | the next 8 bits of the UUID | + +-------------------------------+-------------------------------+ + | :attr:`!clock_seq_low` | the next 8 bits of the UUID | + +-------------------------------+-------------------------------+ + | :attr:`!node` | the last 48 bits of the UUID | + +-------------------------------+-------------------------------+ + | :attr:`!time` | the 60-bit timestamp | + +-------------------------------+-------------------------------+ + | :attr:`!clock_seq` | the 14-bit sequence number | + +-------------------------------+-------------------------------+ .. attribute:: UUID.hex @@ -233,7 +233,7 @@ The :mod:`uuid` module defines the following namespace identifiers for use with text output format. The :mod:`uuid` module defines the following constants for the possible values -of the :attr:`variant` attribute: +of the :attr:`~UUID.variant` attribute: .. data:: RESERVED_NCS diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 1d89c9c683a070..c0fc47cc72029c 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -136,7 +136,6 @@ Doc/library/unittest.mock.rst Doc/library/unittest.rst Doc/library/urllib.parse.rst Doc/library/urllib.request.rst -Doc/library/uuid.rst Doc/library/weakref.rst Doc/library/wsgiref.rst Doc/library/xml.dom.minidom.rst From f734cf1835064dd1b95402250cdffbc4717e2420 Mon Sep 17 00:00:00 2001 From: sobolevn Date: Sat, 2 Sep 2023 12:22:18 +0300 Subject: [PATCH 2/2] Use anchors --- Doc/library/uuid.rst | 47 ++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 19 deletions(-) diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 05b345de9cc6eb..b78e74b4e04f1c 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -95,25 +95,34 @@ which relays any information about the UUID's safety, using this enumeration: A tuple of the six integer fields of the UUID, which are also available as six individual attributes and two derived attributes: - +-------------------------------+-------------------------------+ - | Field | Meaning | - +===============================+===============================+ - | :attr:`!time_low` | the first 32 bits of the UUID | - +-------------------------------+-------------------------------+ - | :attr:`!time_mid` | the next 16 bits of the UUID | - +-------------------------------+-------------------------------+ - | :attr:`!time_hi_version` | the next 16 bits of the UUID | - +-------------------------------+-------------------------------+ - | :attr:`!clock_seq_hi_variant` | the next 8 bits of the UUID | - +-------------------------------+-------------------------------+ - | :attr:`!clock_seq_low` | the next 8 bits of the UUID | - +-------------------------------+-------------------------------+ - | :attr:`!node` | the last 48 bits of the UUID | - +-------------------------------+-------------------------------+ - | :attr:`!time` | the 60-bit timestamp | - +-------------------------------+-------------------------------+ - | :attr:`!clock_seq` | the 14-bit sequence number | - +-------------------------------+-------------------------------+ +.. list-table:: + + * - Field + - Meaning + + * - .. attribute:: UUID.time_low + - The next 32 bits of the UUID. + + * - .. attribute:: UUID.time_mid + - The next 16 bits of the UUID. + + * - .. attribute:: UUID.time_hi_version + - The next 16 bits of the UUID. + + * - .. attribute:: UUID.clock_seq_hi_variant + - The next 8 bits of the UUID. + + * - .. attribute:: UUID.clock_seq_low + - The next 8 bits of the UUID. + + * - .. attribute:: UUID.node + - The last 48 bits of the UUID. + + * - .. attribute:: UUID.time + - The the 60-bit timestamp. + + * - .. attribute:: UUID.clock_seq + - The 14-bit sequence number. .. attribute:: UUID.hex