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

Merged
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-uuid
Sep 2, 2023
ConversationCommits (2)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in uuid.rst#108805
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-uuid

Conversation

sobolevn commented Sep 2, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Warnings before:

/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:22: WARNING: py:attr reference target not found: is_safe
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:102: WARNING: py:attr reference target not found: time_low
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:104: WARNING: py:attr reference target not found: time_mid
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:106: WARNING: py:attr reference target not found: time_hi_version
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:108: WARNING: py:attr reference target not found: clock_seq_hi_variant
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:110: WARNING: py:attr reference target not found: clock_seq_low
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:112: WARNING: py:attr reference target not found: node
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:116: WARNING: py:attr reference target not found: clock_seq
/Users/sobolev/Desktop/cpython/Doc/library/uuid.rst:235: WARNING: py:attr reference target not found: variant

Turns out all attributes that are defined in .fields are not documented intentionally (as far as I understand from the docs.

📚 Documentation preview 📚: https://cpython-previews--108805.org.readthedocs.build/

sobolevn requested a review from hugovk September 2, 2023 08:31
bedevere-bot mentioned this pull request Sep 2, 2023
Closed
AlexWaygood reviewed Sep 2, 2023
View reviewed changes
Comment thread Doc/library/uuid.rst Outdated

sobolevn commented Sep 2, 2023

Copy link
Copy Markdown
Member Author

Looks great:

hugovk approved these changes Sep 2, 2023
View reviewed changes

hugovk left a comment

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

Thanks! And easier to later edit a list-table than mess with the "ASCII art" one :)

hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Sep 2, 2023
hugovk enabled auto-merge (squash) September 2, 2023 09:30

sobolevn commented Sep 2, 2023

Copy link
Copy Markdown
Member Author

mess
"ASCII art"

😢

hugovk merged commit 21da498 into python:main Sep 2, 2023

miss-islington commented Sep 2, 2023

Copy link
Copy Markdown
Contributor

Thanks @sobolevn for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

bedevere-bot commented Sep 2, 2023

Copy link
Copy Markdown

There's a new commit after the PR has been approved.

@hugovk: please review the changes made to this pull request.

bedevere-bot requested a review from hugovk September 2, 2023 09:32
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 2, 2023
pythongh-101100: Fix sphinx warnings in uuid.rst (pythonGH-108805)
c7531cc 
* pythongh-101100: Fix sphinx warnings in `uuid.rst`

* Use anchors
(cherry picked from commit 21da498)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

bedevere-bot commented Sep 2, 2023

Copy link
Copy Markdown

GH-108807 is a backport of this pull request to the 3.12 branch.

bedevere-bot removed the needs backport to 3.12 only security fixes label Sep 2, 2023

bedevere-bot commented Sep 2, 2023

Copy link
Copy Markdown

GH-108808 is a backport of this pull request to the 3.11 branch.

bedevere-bot removed the needs backport to 3.11 only security fixes label Sep 2, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 2, 2023
pythongh-101100: Fix sphinx warnings in uuid.rst (pythonGH-108805)
38a6095 
* pythongh-101100: Fix sphinx warnings in `uuid.rst`

* Use anchors
(cherry picked from commit 21da498)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
hugovk reviewed Sep 2, 2023
View reviewed changes
Comment thread Doc/library/uuid.rst
- 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!

hugovk commented Sep 2, 2023

Copy link
Copy Markdown
Member

mess
"ASCII art"

😢

I mean it can be time-consuming to adjust the layout when changing text that then requires changing the number of hyphens, equals signs, whitespace and so on.

sobolevn mentioned this pull request Sep 2, 2023
Merged
AlexWaygood reviewed Sep 2, 2023
View reviewed changes
Comment thread Doc/library/uuid.rst
- 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

bedevere-bot commented Sep 2, 2023

Copy link
Copy Markdown

GH-108808 is a backport of this pull request to the 3.11 branch.

AlexWaygood added a commit that referenced this pull request Sep 2, 2023
[3.11] gh-101100: Fix sphinx warnings in uuid.rst (GH-108805) (#108808
fa8b9c1 
)

(cherry picked from commit 21da498)

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>

bedevere-bot commented Sep 2, 2023

Copy link
Copy Markdown

GH-108807 is a backport of this pull request to the 3.12 branch.

Yhg1s pushed a commit that referenced this pull request Sep 2, 2023
[3.12] gh-101100: Fix sphinx warnings in uuid.rst (GH-108805) (#108807
54e8dd7 
)

* gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805)

* gh-101100: Fix sphinx warnings in `uuid.rst`

* Use anchors
(cherry picked from commit 21da498)

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>
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk approved these changes
AlexWaygood AlexWaygood left review comments

Assignees

No one assigned

Labels

awaiting core review skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL