Skip to content

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

Jump to bottom
Merged
hugovk merged 2 commits into from
Sep 2, 2023
Merged

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

hugovk merged 2 commits into from
Sep 2, 2023

Conversation

@sobolevn
Copy link
Member

@sobolevnsobolevn commented Sep 2, 2023•
edited by github-actions bot
Loading

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/

@sobolevnsobolevn requested a review from hugovkSeptember 2, 2023 08:31
@bedevere-botbedevere-bot mentioned this pull request Sep 2, 2023
Open
AlexWaygood
AlexWaygood reviewed Sep 2, 2023
View reviewed changes
@sobolevn
Copy link
MemberAuthor

sobolevn commented Sep 2, 2023

Looks great:
Снимок экрана 2023-09-02 в 12 22 02

hugovk
hugovk approved these changes Sep 2, 2023
View reviewed changes
Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

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

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

@hugovkhugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Sep 2, 2023
@hugovkhugovk enabled auto-merge (squash) September 2, 2023 09:30
@sobolevn
Copy link
MemberAuthor

sobolevn commented Sep 2, 2023

mess
"ASCII art"

😢

@hugovkhugovk merged commit 21da498 into python:mainSep 2, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Sep 2, 2023

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
Copy link

bedevere-bot commented Sep 2, 2023

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

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 2, 2023
@sobolevn@miss-islington
pythongh-101100: Fix sphinx warnings inuuid.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
Copy link

bedevere-bot commented Sep 2, 2023

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

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

bedevere-bot commented Sep 2, 2023

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

@bedevere-botbedevere-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
@sobolevn@miss-islington
pythongh-101100: Fix sphinx warnings inuuid.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
hugovk reviewed Sep 2, 2023
View reviewed changes
Doc/library/uuid.rst
- The last 48 bits of the UUID.

* - .. attribute:: UUID.time
- The the 60-bit timestamp.
Copy link
Member

@hugovkhugovkSep 2, 2023

Choose a reason for hiding this comment

The 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 main? (I'm on a phone, otherwise I could do it myself.) Thanks!

@hugovk
Copy link
Member

hugovk commented Sep 2, 2023

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.

@sobolevnsobolevn mentioned this pull request Sep 2, 2023
Merged
AlexWaygood
AlexWaygood reviewed Sep 2, 2023
View reviewed changes
Doc/library/uuid.rst
- Meaning

* - .. attribute:: UUID.time_low
- The next 32 bits of the UUID.
Copy link
Member

@AlexWaygoodAlexWaygoodSep 2, 2023

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:

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

@sobolevn, could you fix it?

Copy link
Member

@AlexWaygoodAlexWaygoodSep 2, 2023

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

@bedevere-bot
Copy link

bedevere-bot commented Sep 2, 2023

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
@miss-islington@sobolevn
@hugovk@AlexWaygood
[3.11]gh-101100: Fix sphinx warnings inuuid.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
Copy link

bedevere-bot commented Sep 2, 2023

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
@miss-islington@sobolevn
@hugovk@AlexWaygood
[3.12]gh-101100: Fix sphinx warnings inuuid.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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes

@AlexWaygoodAlexWaygoodAlexWaygood left review comments

Assignees

No one assigned

Labels

awaiting core reviewskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sobolevn@miss-islington@bedevere-bot@hugovk@AlexWaygood