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

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

  1. python
  2. cpython

Repository navigation

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

Merged
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-lib-enum
Feb 9, 2024
ConversationCommits (2)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in library/enum.rst#114696
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-lib-enum

Conversation

sobolevn commented Jan 29, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

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:

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/

sobolevn requested a review from hugovk January 29, 2024 06:37
sobolevn requested a review from ethanfurman as a code owner January 29, 2024 06:37
bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Jan 29, 2024
bedevere-app Bot mentioned this pull request Jan 29, 2024
Closed
sobolevn added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jan 29, 2024

hugovk commented Jan 31, 2024

Copy link
Copy Markdown
Member

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 requested changes Feb 8, 2024
View reviewed changes

ethanfurman 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

A minor change, then good to go!

Comment thread Doc/library/enum.rst Outdated
Comment thread Doc/library/enum.rst Outdated

bedevere-app Bot commented Feb 8, 2024

Copy link
Copy Markdown

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

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

miss-islington-app Bot commented Feb 9, 2024

Copy link
Copy Markdown

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 Bot commented Feb 9, 2024

Copy link
Copy Markdown

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 Bot commented Feb 9, 2024

Copy link
Copy Markdown

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 commented Feb 9, 2024

Copy link
Copy Markdown
Member Author

I will send backports PRs later 👍

bedevere-app Bot commented Feb 9, 2024

Copy link
Copy Markdown

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

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
[3.11] pythongh-101100: Fix sphinx warnings in library/enum.rst (py…
f7548d4 
…thonGH-114696)

bedevere-app Bot commented Feb 9, 2024

Copy link
Copy Markdown

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

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
[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
[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
pythongh-101100: Fix sphinx warnings in library/enum.rst (python#11…
fdc0650 
…4696)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
hugovk mentioned this pull request Mar 5, 2024
Merged
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

ethanfurman ethanfurman approved these changes
hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees

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

Back | FazBrowse Home | New Git URL