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

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

  1. python
  2. cpython

Repository navigation

gh-101100: Fix sphinx warnings in Doc/library/__future__.rst - #109814

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

gh-101100: Fix sphinx warnings in Doc/library/__future__.rst#109814
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-__future__

Conversation

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

Copy link
Copy Markdown
Member

Before:

/Users/sobolev/Desktop/cpython/Doc/library/__future__.rst:54: WARNING: py:class reference target not found: _Feature
/Users/sobolev/Desktop/cpython/Doc/library/__future__.rst:54: WARNING: py:meth reference target not found: getOptionalRelease
/Users/sobolev/Desktop/cpython/Doc/library/__future__.rst:54: WARNING: py:meth reference target not found: getMandatoryRelease
/Users/sobolev/Desktop/cpython/Doc/library/__future__.rst:57: WARNING: py:attr reference target not found: compiler_flag
/Users/sobolev/Desktop/cpython/Doc/library/__future__.rst:57: WARNING: py:class reference target not found: _Feature

Changes:

  1. I documented _Feature class and its members and added sphinx markup, because they were already documented but without the proper markup

This is now much more readable, has more metadata, and links to every part of the explanation.

  1. I've also changed

MandatoryRelease may also be None, meaning that a planned feature got
dropped.

to be

MandatoryRelease may also be None, meaning that a planned feature got
dropped or that it is not yet decided.

Because of the note below:

No final decision has been made yet. See also :pep:563 and :pep:649.

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

sobolevn requested a review from hugovk September 25, 2023 06:17
bedevere-app Bot mentioned this pull request Sep 25, 2023
Closed
hugovk merged commit f2eaa92 into python:main Sep 25, 2023
csm10495 pushed a commit to csm10495/cpython that referenced this pull request Sep 28, 2023
pythongh-101100: Fix sphinx warnings in Doc/library/__future__.rst (p…
4b65aa2 
…ython#109814)
AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 4, 2023

miss-islington-app Bot commented Dec 4, 2023

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.
🐍🍒⛏🤖

miss-islington-app Bot commented Dec 4, 2023

Copy link
Copy Markdown

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

miss-islington-app Bot commented Dec 4, 2023

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 f2eaa92b0cc5a37a9e6010c7c6f5ad1a230ea49b 3.12

bedevere-app Bot commented Dec 4, 2023

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 4, 2023
pythongh-101100: Fix sphinx warnings in Doc/library/__future__.rst (p…
162810a 
…ythonGH-109814)

(cherry picked from commit f2eaa92)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
bedevere-app Bot removed the needs backport to 3.11 only security fixes label Dec 4, 2023
AlexWaygood mentioned this pull request Dec 4, 2023
Merged
AlexWaygood pushed a commit that referenced this pull request Dec 4, 2023
[3.11] gh-101100: Fix sphinx warnings in Doc/library/__future__.rst (…
28afd8d 
…GH-109814) (#112701)

gh-101100: Fix sphinx warnings in `Doc/library/__future__.rst` (GH-109814)
(cherry picked from commit f2eaa92)

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

bedevere-app Bot commented Dec 4, 2023

Copy link
Copy Markdown

GH-112702 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 Dec 4, 2023
AlexWaygood pushed a commit to AlexWaygood/cpython that referenced this pull request Dec 4, 2023
[3.12] pythongh-101100: Fix sphinx warnings in `Doc/library/__future_…
e7280ad 
…_.rst` (python#109814)

(cherry-picked from commit f2eaa92)
AlexWaygood added a commit that referenced this pull request Dec 4, 2023
[3.12] gh-101100: Fix sphinx warnings in Doc/library/__future__.rst (…
09b3e8f 
…#109814) (#112702)

(cherry-picked from commit f2eaa92)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
pythongh-101100: Fix sphinx warnings in Doc/library/__future__.rst (p…
626e85c 
…ython#109814)
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

Assignees

No one assigned

Labels

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