Skip to content

add docstring to example: axisartist/demo_floating_axes.py #7249

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
merged 4 commits into from
Oct 18, 2016

Conversation

JunTan
Copy link
Contributor

@JunTan JunTan commented Oct 11, 2016

Adding docstring to matplotlib/examples/axisartist.

@NelleV NelleV changed the title add docstring add docstring to example: axisartist/demo_floating_axes.py Oct 11, 2016
@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Oct 11, 2016
@NelleV
Copy link
Member

NelleV commented Oct 11, 2016

Hi @JunTan
Thanks or the patch. Overall this looks good! Can you just reformat the docstring such that it is as follow:

"""
title

description
"""

@@ -1,3 +1,10 @@
"""
Demo of the scatter function and bar function with changing the shape of the plot.
Copy link
Member

Choose a reason for hiding this comment

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

I'd make the title shorter, and about the features showcases here: something as simple as "Floating axes" would work well here.

Copy link
Member

Choose a reason for hiding this comment

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

Please also wrap all the lines at 79 characters.

@NelleV
Copy link
Member

NelleV commented Oct 14, 2016

That's strange… The pep8 tests fail on lines you did not modify.
@tacaswell is that normal?

@NelleV
Copy link
Member

NelleV commented Oct 14, 2016

@tacaswell never mind… I confused lines and colums in the pep8 error message.

@NelleV NelleV changed the title add docstring to example: axisartist/demo_floating_axes.py [MRG+1] add docstring to example: axisartist/demo_floating_axes.py Oct 14, 2016
* Using scatter function and bar function with changing the
shape of the plot.
* Using GridHelperCurveLinear to rotate the plot and set the
boundary of the plot .
Copy link
Member

Choose a reason for hiding this comment

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

space before dot

Copy link
Member

Choose a reason for hiding this comment

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

Good catch!

@QuLogic QuLogic changed the title [MRG+1] add docstring to example: axisartist/demo_floating_axes.py add docstring to example: axisartist/demo_floating_axes.py Oct 18, 2016
@QuLogic QuLogic merged commit 987199c into matplotlib:master Oct 18, 2016
QuLogic added a commit that referenced this pull request Oct 18, 2016
add docstring to example: axisartist/demo_floating_axes.py
@QuLogic
Copy link
Member

QuLogic commented Oct 18, 2016

Backported to v2.x via 35aa62d.

QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Oct 18, 2016
add docstring to example: axisartist/demo_floating_axes.py
@JunTan JunTan deleted the 7206 branch November 3, 2016 22:15
@QuLogic QuLogic modified the milestones: 2.0.1 (next bug fix release), 2.0 (style change major release) Dec 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants