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

Docs: Resolve Sphinx warnings in dis.rst #108476

Merged
merged 2 commits into from
Aug 25, 2023

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Aug 25, 2023

  • Link to the code objects reference
  • Suppress link to deliberately undocumented builtins.__build_class__
  • Suppress links for example methods

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

- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

LGTM

@erlend-aasland
Copy link
Contributor Author

Thanks for the review, Alex!

@erlend-aasland erlend-aasland merged commit cb11842 into python:main Aug 25, 2023
22 checks passed
@miss-islington

This comment was marked as outdated.

@erlend-aasland erlend-aasland deleted the docs/dis.rst branch August 25, 2023 11:28
@miss-islington

This comment was marked as outdated.

@miss-islington

This comment was marked as outdated.

@erlend-aasland

This comment was marked as outdated.

@serhiy-storchaka
Copy link
Member

LGTM.

@erlend-aasland erlend-aasland added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes and removed needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Aug 27, 2023
@miss-islington
Copy link
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @erlend-aasland, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker cb1184280b3fb369a07abb4153aa36829cf1df9b 3.11

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Aug 27, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 27, 2023
- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
(cherry picked from commit cb11842)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
@erlend-aasland erlend-aasland removed the needs backport to 3.11 only security fixes label Aug 27, 2023
@erlend-aasland
Copy link
Contributor Author

dis.rst looks a lot more different in 3.11 than in 3.12; I'm not sure that backport is worth it.

Yhg1s pushed a commit that referenced this pull request Aug 27, 2023
Docs: Resolve Sphinx warnings in dis.rst (GH-108476)

- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
(cherry picked from commit cb11842)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
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.

5 participants