Axes.stem docstring document orientation as literals #24807
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
We use `_api.check_in_list` in the method body, so arbitrary strings are not accetable and will raise if it is not precisely "vertical" or "horizontal". This brings the docstring in line with this behavior. Many other places which have an orientation kwarg are similarly documented.
QuLogic
reviewed
Dec 22, 2022
Co-authored-by: Elliott Sales de Andrade <[email protected]>
timhoffm
approved these changes
Dec 22, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 22, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 22, 2022
rcomer
added a commit
that referenced
this pull request
Dec 22, 2022
…807-on-v3.6.x Backport PR #24807 on branch v3.6.x (Axes.stem docstring document orientation as literals)
raphaelquast
pushed a commit
to raphaelquast/matplotlib
that referenced
this pull request
Mar 16, 2023
* Axes.stem docstring document orientation as literals We use `_api.check_in_list` in the method body, so arbitrary strings are not accetable and will raise if it is not precisely "vertical" or "horizontal". This brings the docstring in line with this behavior. Many other places which have an orientation kwarg are similarly documented. Co-authored-by: Tim Hoffmann <[email protected]> Co-authored-by: Elliott Sales de Andrade <[email protected]>
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
We use
_api.check_in_listin the method body, so arbitrary strings arenot accetable and will raise if it is not precisely "vertical" or
"horizontal".
This brings the docstring in line with this behavior.
Many other places which have an orientation kwarg are similarly
documented.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst