Fix rendering of string-valued defaults #137
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
hoodmane
force-pushed
the
empty-string-default
branch
2 times, most recently
from
6e2ae93 to
88e1a84
Compare
|
There's still a |
hoodmane
added a commit
to hoodmane/pyodide
that referenced
this pull request
May 9, 2024
I made two PRs to sphinx-click and this uses them: click-contrib/sphinx-click#137 click-contrib/sphinx-click#138
hoodmane
added a commit
to pyodide/pyodide
that referenced
this pull request
May 9, 2024
…gs (#4750) I made two PRs to sphinx-click and this uses them: click-contrib/sphinx-click#137 click-contrib/sphinx-click#138
stephenfin
requested changes
May 14, 2024
|
You can rebase this now that #136 is merged too. |
Before this patch, string defaults are formatted without quotes around
them. However, if the default is a tuple or list of strings, quotes will
be included:
default="a" ==> :default: ``a``
default=("a",) ==> :default: ``('a')``
This is a slightly annoying inconsistency, and leads to potential for
confusion between `default="0"` and `default=0`. Most bothersome is that
in the case of an empty string we get:
:default: ````
Which makes docutils angry:
CRITICAL: Unexpected section title or transition.
This fixes the trouble by formatting the repr of the default.
stephenfin
force-pushed
the
empty-string-default
branch
from
3354956 to
4953efe
Compare
|
Thanks for maintaining sphinx-click @stephenfin! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Before this patch, string defaults are formatted without quotes around them.
However, if the default is a tuple or list of strings, quotes will be included:
This is a slightly annoying inconsistency, and leads to potential for confusion
between
default="0"anddefault=0. Most bothersome is that in the case of anempty string we get:
Which makes docutils angry:
This fixes the trouble by formatting the repr of the default.
On top of #136.
Tasks
reno)tox)