gh-148961 : Use parsed-literal for the slot column legend in c-api/typeobj.rst#148962
Open
Chang-LeHung wants to merge 1 commit intopython:mainfrom
Open
gh-148961 : Use parsed-literal for the slot column legend in c-api/typeobj.rst#148962Chang-LeHung wants to merge 1 commit intopython:mainfrom
Chang-LeHung wants to merge 1 commit intopython:mainfrom
Conversation
bedevere-app
Bot
added
awaiting review
docs
| **"D"**: default (if slot is set to ``NULL``) | ||
|
|
||
| .. code-block:: none | ||
| .. parsed-literal:: |
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
2 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.
The two small legends under the
PyTypeObject"Quick Reference" table inDoc/c-api/typeobj.rstexplain what each character in the"D"(default)and
"I"(inheritance) columns means. They were wrapped in.. code-block:: none, so reST inline markup inside them was renderedverbatim:
*PyType_Ready*and*NULL*showed literal asterisks.PyType_Readywas plain text instead of a cross-reference link.NULLwas plain text instead of theNULLinline literal usedthroughout the rest of the page.
Before:
After:
c-api/typeobj.rstlegend is not rendered because of.. code-block:: none#148961📚 Documentation preview 📚: https://cpython-previews--148962.org.readthedocs.build/