Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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

Merged

Conversation

tacaswell
Copy link
Member

  • Annotation class
  • OffsetFrom class
  • Axes.annotate

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.

@tacaswell tacaswell force-pushed the doc_annotation_docstrings branch 3 times, most recently from 59cc54d to 3cf4106 Compare May 23, 2016 02:16
@jenshnielsen
Copy link
Member

PEP8 fail with a few lines to long

@tacaswell tacaswell added this to the 1.5.2 (Critical bug fix release) milestone May 23, 2016
-------
Annotation

Notes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any notes?

@jenshnielsen
Copy link
Member

👍 once the pep8 error is fixed

@tacaswell tacaswell force-pushed the doc_annotation_docstrings branch from 3cf4106 to bf710e0 Compare May 28, 2016 02:19
@tacaswell
Copy link
Member Author

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`
Copy link
Member

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...

Copy link
Member Author

@tacaswell tacaswell May 28, 2016

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-
.

Copy link
Member

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.

@jenshnielsen
Copy link
Member

OK to self merge once inline comments are fixed

@tacaswell tacaswell force-pushed the doc_annotation_docstrings branch 2 times, most recently from 6cb4802 to 4fd588d Compare May 30, 2016 20:54
 - Annotation class
 - OffsetFrom class
 - Axes.annotate
@tacaswell tacaswell force-pushed the doc_annotation_docstrings branch from 4fd588d to e89d32d Compare May 30, 2016 20:55
@tacaswell
Copy link
Member Author

comments are addressed and force-pushed.

@jenshnielsen jenshnielsen merged commit 80c884a into matplotlib:v1.5.x Jun 6, 2016
@tacaswell tacaswell deleted the doc_annotation_docstrings branch July 9, 2016 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.