Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.11] gh-101100: Fix sphinx warnings in uuid.rst (GH-108805) #108808

Merged
merged 3 commits into from
Sep 2, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 30 additions & 21 deletions Doc/library/uuid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved

* - .. 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
Expand Down Expand Up @@ -231,7 +240,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
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,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
Expand Down