-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: update annotation docstrings #6464
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
DOC: update annotation docstrings #6464
Conversation
59cc54d
to
3cf4106
Compare
PEP8 fail with a few lines to long |
------- | ||
Annotation | ||
|
||
Notes |
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.
Are there any notes?
👍 once the pep8 error is fixed |
3cf4106
to
bf710e0
Compare
fixed. Discovered I did not have flake8 installed in my dev enviroment so I was only getting pyflake warnings not pep8 warnings. |
@@ -1657,17 +1657,41 @@ def set_figure(self, fig): | ||
|
||
|
||
class OffsetFrom(object): | ||
'''Callable helper class for working with `Annotation` |
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.
I'm normally a proponent of single quotes because they're easier to type, but isn't the convention to use double quotes for docstrings? Not that that's a huge difference or anything...
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.
Raymond Hettinger in https://www.youtube.com/watch?v=wf-BqAjZb8M suggest
triple single quotes for docstrings.
On Sat, May 28, 2016 at 4:40 PM Elliott Sales de Andrade <
notifications@github.com> wrote:
In lib/matplotlib/text.py
#6464 (comment):@@ -1657,17 +1657,41 @@ def set_figure(self, fig):
class OffsetFrom(object):
- '''Callable helper class for working with
Annotation
I'm normally a proponent of single quotes because they're easier to type,
but isn't the convention to use double quotes for docstrings? Not that
that's a huge difference or anything...—
You are receiving this because you authored the thread.Reply to this email directly, view it on GitHub
https://github.com/matplotlib/matplotlib/pull/6464/files/bf710e0e353364ff0328d515a200fb2a11f859f8#r64994068,
or mute the thread
https://github.com/notifications/unsubscribe/AAMMhUVxntJ7GX4t2ruF4isYAqhh2bDSks5qGKgrgaJpZM4IkE5-
.
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.
I guess that's new; it's PEP257 which suggests triple double quotes.
OK to self merge once inline comments are fixed |
6cb4802
to
4fd588d
Compare
- Annotation class - OffsetFrom class - Axes.annotate
4fd588d
to
e89d32d
Compare
comments are addressed and force-pushed. |
attn @efiring @leejjoon
I would like this merged before a 1.5.2 final, but am going to tag a 1.5.2rc1 without it.