Reorganize colorbar docstrings. #17780
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
- Figure.colorbar and pyplot.colorbar can use the docstring (no need to restate the signatures, IPython/pydoc/sphinx does that for you). - Deprecate some docstrings that exist as globals at the module level. - Clarify what happens when `cax` and `ax` are both given (we can always emit a warning and deprecate that behavior later).
tacaswell
approved these changes
Jun 28, 2020
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.
restate the signatures, IPython/pydoc/sphinx does that for you).
caxandaxare both given (we can alwaysemit a warning and deprecate that behavior later).
PR Summary
PR Checklist