Add note to errorbar function about sign of errors #12775
Merged
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
anntzer
reviewed
Nov 8, 2018
| @@ -2950,6 +2950,8 @@ def errorbar(self, x, y, yerr=None, xerr=None, | |||
| upper errors. | |||
There was a problem hiding this comment.
Thanks for the PR!
I think I'd rather have it go as a parenthetical statement here? e.g. (both of them must be positive). (It's also true for the other cases but I think it's kind of obvious for them?)
|
This is an improvement, going to merge. Thanks @themightyoarfish ! Congratulations on your first Matplotlib contribution 🎉 ! Hopefully we will here from you again! |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 8, 2018
timhoffm
pushed a commit
that referenced
this pull request
Nov 9, 2018
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.
This is purely a docstring change.
I was tripped up by the sign the errors need to have. Both lower and upper bounds are always positive numbers, so it would be useful to note this in the documentation.