DOC: Fix label type specification in parameter descriptions #27981
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
- add missing "or list of str" in hist() docstring - Use "optional" instead of "default: None" See https://matplotlib.org/devdocs/devel/document.html > If None is only used as a sentinel value for "parameter not specified", > do not document it as the default. Depending on the context, give the > actual default, or mark the parameter as optional if not specifying has > no particular effect.
tacaswell
approved these changes
Mar 27, 2024
|
Failures look like gtk4 packaging issues on windows via conda-forge. |
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.
add missing "or list of str" in hist() docstring
Use "optional" instead of "default: None"
See https://matplotlib.org/devdocs/devel/document.html