Skip to content
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.

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

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

Merged
merged 2 commits into from
Sep 25, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Sep 25, 2023

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
Снимок экрана 2023-09-25 в 09 12 59

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/

@hugovk hugovk merged commit f2eaa92 into python:main Sep 25, 2023
24 checks passed
csm10495 pushed a commit to csm10495/cpython that referenced this pull request Sep 28, 2023
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Dec 4, 2023
@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.
🐍🍒⛏🤖

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

@bedevere-app
Copy link

bedevere-app bot commented Dec 4, 2023

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
…ythonGH-109814)

(cherry picked from commit f2eaa92)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 4, 2023
AlexWaygood pushed a commit that referenced this pull request Dec 4, 2023
…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
Copy link

bedevere-app bot commented Dec 4, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Dec 4, 2023
AlexWaygood pushed a commit to AlexWaygood/cpython that referenced this pull request Dec 4, 2023
AlexWaygood added a commit that referenced this pull request Dec 4, 2023
…#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants