Skip to content
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 : top_level doc-string clean up #3228

Merged
merged 2 commits into from Jul 12, 2014

Conversation

tacaswell
Copy link
Member

  • remove import * examples
  • remove pylab

 - remove import * examples
 - remove pylab
@tacaswell tacaswell added this to the v1.4.0 milestone Jul 12, 2014
@tacaswell
Copy link
Member Author

Tagging this as critical as it is doc that will go to the binary builders, not just sphinx inputs.

To include numpy functions too, use::

from pylab import *
from matplotlib import pyplot as plt
Copy link
Member

Choose a reason for hiding this comment

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

I think the convention is import matplotlib.pyplot as plt (I prefer from matplotlib import pyplot as plt, but for the sake of consistency, we should use the same everywhere).

Copy link
Member

Choose a reason for hiding this comment

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

Ditto to Nelle. I wish the matplotlib.pyplot convention wasn't adopted, but it was...

@tacaswell
Copy link
Member Author

This is an example of the PEP8 being flaky.

@NelleV
Copy link
Member

NelleV commented Jul 12, 2014

I think the failed travis build is a false positive, but I can't seem to confirm this.

@tacaswell
Copy link
Member Author

I looked at the line it is complaining about and it is a very short comment line. It passed on 3.4 in the first test without any problems. Pretty sure we can disregarde that failure.

NelleV added a commit that referenced this pull request Jul 12, 2014
DOC : top_level doc-string clean up
@NelleV NelleV merged commit 496d7a7 into matplotlib:master Jul 12, 2014
@tacaswell tacaswell deleted the top_level_docstring branch July 13, 2014 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants