Doc: Do not write default for non-existing rcParams #15231
Merged
Conversation
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
dstansby
approved these changes
Sep 10, 2019
| @@ -4,8 +4,12 @@ | |||
|
|
|||
|
|
|||
| def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]): | |||
| param = rcParamsDefault.get(text) | |||
| rendered = nodes.Text(f'rcParams["{text}"] = {param!r}') | |||
| try: | |||
There was a problem hiding this comment.
Is there a reason to use try... except... instead of if text in rcParamsDefault?
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.
PR Summary
#15115 introduced automatic documentation of rcParams defaults. We have some special-named references such as wildcards. They were documented as defaulting to
None:This PR changes the behavior to simply not show any default in such a case.
Note: If one wanted to be more strict, one could alternatively exclude wildcard references and error out/warn if other references are encountered.