fix indentation in docstring interpolation for spy. #12066
Merged
+1
−1
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
All's in the title.
timhoffm
approved these changes
Sep 7, 2018
jklymak
reviewed
Sep 7, 2018
| @@ -7681,7 +7681,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None, | |||
| For the marker style, you can pass any `.Line2D` property except | |||
| for *linestyle*: | |||
|
|
|||
| %(Line2D)s | |||
| %(Line2D)s | |||
There was a problem hiding this comment.
Just a comment/question. Would anyone freak out if I put in a PR that renamed this _Line2D_docstring - its a real PITA trying to find where this is defined by doing a global search.
ivanov
approved these changes
Sep 8, 2018
There was a problem hiding this comment.
Looks great, thanks @anntzer !
Verified that the docstring before this change read as
...
- any `.Artist` properties (passed on to the `.AxesImage`) [258/1639]
For the marker style, you can pass any `.Line2D` property except
for *linestyle*:
agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha: float
animated: bool
antialiased: bool
clip_box: `.Bbox`
...
but now that first kwarg is properly indented like so:
...
For the marker style, you can pass any `.Line2D` property except
for *linestyle*:
agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha: float
animated: bool
antialiased: bool
clip_box: `.Bbox`
...
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.
All's in the title.
PR Summary
PR Checklist