Inherit more docstrings. #13389
Merged
Inherit more docstrings. #13389
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
This caught a few places where a docstring assignment previously overwrote an explicit docstring (`PolarAxes.__init__`, `Barbs.set_offsets`) or where a bunch of methods were aliases to each other, but then docstrings were repeatedly overwritten (IndentityTransform methods). For Axes methods that are straight pass-throughs of functions defined elsewhere, on the other hand, straight aliasing yields better pyplot signatures (as seen in the pyplot diff).
9a623ac to
816224f
Compare
dstansby
approved these changes
Feb 8, 2019
jklymak
approved these changes
Feb 8, 2019
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.
This caught a few places where a docstring assignment previously
overwrote an explicit docstring (
PolarAxes.__init__,Barbs.set_offsets) or where a bunch of methods were aliases to eachother, but then docstrings were repeatedly overwritten
(IndentityTransform methods).
For Axes methods that are straight pass-throughs of functions defined
elsewhere, on the other hand, straight aliasing yields better pyplot
signatures (as seen in the pyplot diff).
PR Summary
PR Checklist