-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
gh-101100: Fix sphinx warnings in uuid.rst
#108805
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry, I missed the "the the" typo here. I've fixed it in the backports, please could you fix |
||
|
||
* - .. 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 | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's another mistake here:
@sobolevn, could you fix it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For future reference: this is being addressed in #108810