-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Addresses issue #5704. Makes usage of parameters clearer #5709
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@tacaswell please have a look. |
It looks like there are some pep8 issues:
Can you please wrap those lines to <80 characters? |
@@ -632,22 +632,21 @@ def annotate(self, *args, **kwargs): | |||
s : string | |||
label | |||
|
|||
xy : (x, y) | |||
position of element to annotate | |||
xy : (x, y) , default: "data" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This does not default to 'data'
.
I would add something to the body of this parameter like 'see xycoords
to control what coordinate system this value is interpreted in' and something similar for xytext
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh sorry I'll remove the default value for xy
. Yes what you said makes it much clearer but then I think I'll have to use the next line. Is it fine if I do so? Ideally I don't really want to do that though...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use as many lines as you need.
Not everything can be documented in about half a tweet
On Tue, Dec 22, 2015, 01:34 Devashish Deshpande notifications@github.com
wrote:
In lib/matplotlib/axes/_axes.py
#5709 (comment):@@ -632,22 +632,21 @@ def annotate(self, _args, *_kwargs):
s : string
label
xy : (x, y)
position of element to annotate
xy : (x, y) , default: "data"
Oh sorry I'll remove the default value for xy. Yes what you said makes it
much clearer but then I think I'll have to use the next line. Is it fine if
I do so? Ideally I don't really want to do that though...—
Reply to this email directly or view it on GitHub
https://github.com/matplotlib/matplotlib/pull/5709/files#r48225539.
@tacaswell I'm not able to understand why it's failing now.... |
Restarted, That particular failure is checking relative speeds, but the tests run on VMs without any performance guarantees so it intermittently fails (see that one maybe once or twice a week). |
Oh alright thanks! |
DOC: clarify annotation parameter usage #5704
Thanks! Contributions to documentation are as or more important as code contributions. 👍 |
DOC: clarify annotation parameter usage #5704
backported to 1.5.x as 82b29ae |
Will surely keep that in mind :-) |
Just added a few lines to make the dependence of the different parameters clearer.