8000 gh-101100: Fix sphinx warnings in `library/enum.rst` by sobolevn · Pull Request #114696 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-101100: Fix sphinx warnings in library/enum.rst #114696

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
merged 2 commits into from
Feb 9, 2024
Merged

gh-101100: Fix sphinx warnings in library/enum.rst #114696

merged 2 commits into from
Feb 9, 2024

Conversation

sobolevn
Copy link
Member
@sobolevn sobolevn commented Jan 29, 2024 •
edited by github-actions bot
Loading

Before:

/Users/sobolev/Desktop/cpython2/Doc/library/enum.rst:798: WARNING: py:attr reference target not found: Enum._name_
/Users/sobolev/Desktop/cpython2/Doc/library/enum.rst:799: WARNING: py:attr reference target not found: Enum._value_
/Users/sobolev/Desktop/cpython2/Doc/library/enum.rst:805: WARNING: py:attr reference target not found: Enum._order_

It renders just fine:
Снимок экрана 2024-01-29 в 09 34 09

I though that I can possibly define these attributes in-place, but their rendering would be very strange this way. So, I went with a little duplication.

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

< 8000 /form>
@sobolevn sobolevn requested a review from hugovk January 29, 2024 06:37
@sobolevn sobolevn requested a review from ethanfurman as a code owner January 29, 2024 06:37
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jan 29, 2024
@bedevere-app bedevere-app bot mentioned this pull request Jan 29, 2024
Open
@sobolevn sobolevn added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jan 29, 2024
@hugovk
Copy link
Member
hugovk commented Jan 31, 2024

Technically looks okay, but let's check with @ethanfurman: if the whole point of _order_ is for Python 2/3 consistency, do we need to keep that detail in the docs?

ethanfurman
ethanfurman requested changes Feb 8, 2024
View reviewed changes
Copy link
Member
@ethanfurman ethanfurman left a comment

Choose a reason for hiding this comment

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

A minor change, then good to go!

@bedevere-app
Copy link
bedevere-app bot commented Feb 8, 2024

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@sobolevn @ethanfurman
Apply suggestions from code review
cd9482b 
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
@sobolevn sobolevn requested a review from ethanfurman February 9, 2024 00:10
@hugovk hugovk merged commit 553c90c into python:main Feb 9, 2024
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 553c90ccc2f5b15be76a2bb6e38d23e58d739e2f 3.12

@miss-islington-app
Copy link

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 553c90ccc2f5b15be76a2bb6e38d23e58d739e2f 3.11

@sobolevn
Copy link
Member Author
sobolevn commented Feb 9, 2024

I will send backports PRs later 👍

@bedevere-app
Copy link
bedevere-app bot commented Feb 9, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 9, 2024
sobolevn added a commit to sobolevn/cpython that referenced this pull request Feb 9, 2024
@sobolevn
[3.11] pythongh-101100: Fix sphinx warnings in library/enum.rst (py…
f7548d4 
…thonGH-114696)
@bedevere-app
Copy link
bedevere-app bot commented Feb 9, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 9, 2024
ethanfurman pushed a commit that referenced this pull request Feb 9, 2024
@sobolevn
[3.11] gh-101100: Fix sphinx warnings in library/enum.rst (GH-114696)…
ca3eca1 
… (GH-115209)
ethanfurman pushed a commit that referenced this pull request Feb 9, 2024
@sobolevn
[3.12] gh-101100: Fix sphinx warnings in library/enum.rst (GH-114696)…
3539b02 
… (GH-115208)
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull request Feb 14, 2024
@sobolevn @ethanfurman @fsc-eriker
pythongh-101100: Fix sphinx warnings in library/enum.rst (python#11…
fdc0650 
…4696)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
@hugovk hugovk mentioned this pull request Mar 5, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ethanfurman ethanfurman ethanfurman approved these changes

@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees

@hugovk hugovk

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sobolevn @hugovk @ethanfurman
0