Convert streamplot to numpydoc #13078
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
cf00369 to
194b18f
Compare
anntzer
reviewed
Jan 2, 2019
timhoffm
reviewed
Jan 2, 2019
| (min, max) to (0, 1). Only necessary when *color* is an array. | ||
| *arrowsize* : float | ||
| norm : :class:`~matplotlib.colors.Normalize` | ||
| Normalize object used to scale luminance data to 0, 1. If ``None``, |
There was a problem hiding this comment.
Personally, I'd go for *None* instead. But we don't have a common practice defined for these and both variants do currently occur in the code.
There was a problem hiding this comment.
I use double ticks since None is technically a snippet of code. I thought stars were reserved for keyword arguments?
There was a problem hiding this comment.
- https://devguide.python.org/documenting/ recommends code-format
- numpydoc and sphinx do not use any highlighting
- I don't remember where, but I've seen italic format as well.
There is no universal standard but code format is fine. We might want to agree on one style but that's something for another issue.
timhoffm
approved these changes
Jan 3, 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.
Does what it says on the tin. I'm happy to fix formatting, but I don't want to deal with the actual docstring content in this PR.