FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix sphinx warnings in `uuid.rst` by sobolevn · Pull Request #108805 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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.

Sign up for GitHub

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
hugovk merged 2 commits into from
Sep 2, 2023
Conversation 14 Commits 2 Checks 0 Files changed
Merged

gh-101100: Fix sphinx warnings in uuid.rst #108805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa50342
gh-101100: Fix sphinx warnings in `uuid.rst`
sobolevn Sep 2, 2023
f734cf1
Use anchors
sobolevn Sep 2, 2023
File filter

Filter by extension

Filter by extension .rst  (1) dotfile  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
51 changes: 30 additions & 21 deletions Doc/library/uuid.rst
Show comments
View file
Open in desktop
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
Show hidden characters
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 Sep 2, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

There's another mistake here:

Suggested change
- The next 32 bits of the UUID.
- The first 32 bits of the UUID.

@sobolevn, could you fix it?

AlexWaygood Sep 2, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

For future reference: this is being addressed in #108810

* - .. 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.

hugovk Sep 2, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Sorry, I missed the "the the" typo here. I've fixed it in the backports, please could you fix main? (I'm on a phone, otherwise I could do it myself.) Thanks!

* - .. attribute:: UUID.clock_seq
- The 14-bit sequence number.


.. attribute:: UUID.hex
Expand Down Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Back | FazBrowse Home | New Git URL