Docs: Add classes to C API return value annotations#117926
Merged
hugovk merged 5 commits intopython:mainfrom Apr 16, 2024
Merged
Docs: Add classes to C API return value annotations#117926hugovk merged 5 commits intopython:mainfrom
hugovk merged 5 commits intopython:mainfrom
Conversation
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
sobolevn
approved these changes
Apr 16, 2024
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Apr 16, 2024
(cherry picked from commit 3284b84) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
|
GH-117937 is a backport of this pull request to the 3.12 branch. |
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this pull request
Apr 17, 2024
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Member
Author
|
Step two: python/python-docs-theme#188 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently light green is used for all return types
For example: https://docs.python.org/3/c-api/exceptions.html
Screenshots
A borrowed reference is not necessarily a "bad" thing, but we may want to use something other than green that indicates it's "good", to indicate they should be treated with care.
One option is yellow.
These annotations are added in
Doc/tools/extensions/c_annotations.py. The first step is to add CSS classes in this file.The light green colour is defined in https://github.com/python/python-docs-theme. The second step is to adjust the colours in the theme.
This PR also includes some light cleanup whilst we're touching this file, see commits.
📚 Documentation preview 📚: https://cpython-previews--117926.org.readthedocs.build/