Convert SymmetricalLogScale to numpydoc #14290
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
timhoffm
reviewed
May 21, 2019
anntzer
reviewed
May 22, 2019
| @@ -544,39 +544,35 @@ class SymmetricalLogScale(ScaleBase): | ||
| need to have a range around zero that is linear. The parameter | ||
| *linthresh* allows the user to specify the size of this range | ||
| (-*linthresh*, *linthresh*). | ||
|
|
||
| Parameters |
There was a problem hiding this comment.
Not to hold up this PR but we may want to record somewhere the decision of whether constructor parameters should be documented in the class' docstring or in the __init__ docstring.
There was a problem hiding this comment.
I'm going off the numpydoc guide (https://numpydoc.readthedocs.io/en/latest/format.html#class-docstring), but I agree it would be nice to document this in our own doc guide.
|
CI errors likely fixed by #14299. Please rebase. |
Co-Authored-By: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
May 25, 2019
efiring
added a commit
that referenced
this pull request
May 25, 2019
…290-on-v3.1.x Backport PR #14290 on branch v3.1.x (Convert SymmetricalLogScale to numpydoc)
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.
No description provided.