numpydocification. #13897
Merged
numpydocification. #13897
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
timhoffm
reviewed
Apr 9, 2019
lib/matplotlib/axes/_base.py
Outdated
| @@ -1410,10 +1412,14 @@ def set_anchor(self, anchor, share=False): | |||
|
|
|||
| def get_data_ratio(self): | |||
| """ | |||
| Returns the aspect ratio of the raw data. | |||
| Returns | |||
There was a problem hiding this comment.
In general, I would like docstrings to have a summary line. Not least because this is used in summaries such as
.
Transforming to a returns section does only add the minor value of stating that it's a float.
There was a problem hiding this comment.
Agreed. Restored the cases where the summary line indeed fits in a single line (for the longer cases, e.g. get_xaxis_text1_transform, I think the Returns section is more readable).
timhoffm
approved these changes
Apr 13, 2019
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 13, 2019
timhoffm
added a commit
that referenced
this pull request
Apr 13, 2019
…897-on-v3.1.x Backport PR #13897 on branch v3.1.x (numpydocification.)
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
PR Checklist