Add an option for displaying short Literal types
#11109
Merged
Conversation
This file contains 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
|
Thanks for implementing this. I think just the Python domain changes are needed, and the autodoc changes should be skipped, since I think it introduces an ambiguity with string literals and it is not clear to me what purpose it serves. I think it is better to always pass valid Python syntax to the Python domain directives, and just do this transformation when converting to docutils nodes. |
AA-Turner
force-pushed
the
short-literals
branch
3 times, most recently
from
a2de47c
to
29b789b
Compare
The new ``python_display_short_literal_types`` configuration option for the ``py`` domain controls display of PEP 586 ``Literal`` types. The 'short' format is inspired by PEP 604, using the bitwise OR operator to distinguish the possible legal values for the argument.
AA-Turner
force-pushed
the
short-literals
branch
from
29b789b
to
4396e92
Compare
|
@jbms How's this much simpler implementation? A |
|
Looks good to me, thanks! |
AA-Turner
changed the title
Literal types
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #9643
cc: @jbms
A