documentation fix regarding contour and tricontour (#9088) #9472
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
jklymak
requested changes
Oct 18, 2017
lib/matplotlib/contour.py
Outdated
| @@ -1672,7 +1672,9 @@ def _initialize_x_y(self, z): | |||
| contour(Z,N) | |||
| contour(X,Y,Z,N) | |||
|
|
|||
| contour up to *N* automatically-chosen levels. | |||
| contour up to *N+1* automatically-chosen levels. | |||
| If exactly *N* levels are required either *V* or an | |||
There was a problem hiding this comment.
*V* is described right below. I'd favour either just the first sentence or maybe even:
contour up to *N+1* automatically chosed contour levels (*N* intervals).
Just to make it not seem like we are bonkers to have this convention.
|
Yes I agree it is too much information. Only the clarification that there are N+1 levels is necessary. |
|
I'll merge later so long as the tests pass (though they almost certainly will, unless some of those lines got too long for PEP8). Thanks! |
jklymak
approved these changes
Oct 18, 2017
|
Unfortunately, they're one character too long. |
|
Thanks a lot @verginer |
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.
I have changed the doc string of
contourandtricontourto address the issue raised in (#9088).Regarding the ambiguous number of levels.
PR Summary
The change clarifies what
Ndoes in the contour functions and states that it can be as highas
N+1which would otherwise be surprising.Related issue: #9088
PR Checklist