summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNikita Sobolev <mail@sobolevn.me>2023-09-02 09:32:19 (GMT)
committerGitHub <noreply@github.com>2023-09-02 09:32:19 (GMT)
commit21da4980f5916e8fd648f04367a9e60d141af366 (patch)
treeb0c49d5b98e2d6ac338d63f2759e2756e679c21f
parentf3ba0a74cd50274acdcd592d4ce8395b92492b7c (diff)
downloadcpython-21da4980f5916e8fd648f04367a9e60d141af366.zip
cpython-21da4980f5916e8fd648f04367a9e60d141af366.tar.gz
cpython-21da4980f5916e8fd648f04367a9e60d141af366.tar.bz2
gh-101100: Fix sphinx warnings in `uuid.rst` (#108805)
* gh-101100: Fix sphinx warnings in `uuid.rst` * Use anchors
-rw-r--r--Doc/library/uuid.rst51
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 30 insertions, 22 deletions
diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst
index 94b9a43..b78e74b 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,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
@@ -233,7 +242,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 1d89c9c..c0fc47c 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