summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-09-02 21:45:40 (GMT)
committerGitHub <noreply@github.com>2023-09-02 21:45:40 (GMT)
commit54e8dd757cb3e41fc479be23db925fc3a475f185 (patch)
tree87299a86bdf02bdcc3e6fd49166f75fa482bc50a
parentb862c25922764eb7bb3cd93dc91fd15c8e92d4f2 (diff)
downloadcpython-54e8dd757cb3e41fc479be23db925fc3a475f185.zip
cpython-54e8dd757cb3e41fc479be23db925fc3a475f185.tar.gz
cpython-54e8dd757cb3e41fc479be23db925fc3a475f185.tar.bz2
[3.12] gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805) (#108807)
* gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805) * gh-101100: Fix sphinx warnings in `uuid.rst` * Use anchors (cherry picked from commit 21da4980f5916e8fd648f04367a9e60d141af366) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> * Fix typo * another typo --------- Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
-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..adf0177 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 first 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 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 75c6a8f..5a824a4 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -150,7 +150,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/webbrowser.rst
Doc/library/wsgiref.rst