changes for MEP12/sphinx-gallery compliance #8209

yinleon · 2017-03-07T02:02:54Z

Regarding #7206

tacaswell · 2017-03-07T02:37:37Z

examples/event_handling/poly_editor.py

@@ -1,4 +1,8 @@
 """
+===========
+Poly Editor
+==========


missing '='

tacaswell · 2017-03-07T02:41:46Z

examples/event_handling/resample.py

 # A class that will downsample the data and recompute when zoomed.
 class DataDisplayDownsampler(object):
    def __init__(self, xdata, ydata):
        self.origYData = ydata
        self.origXData = xdata
-        self.ratio = 5
+        self.ratio = 50


This seems a bit too aggressive.

tacaswell · 2017-03-07T02:42:52Z

Left 2 small comments, but otherwise looks good!

tacaswell · 2017-03-07T02:43:13Z

In the future, it is better to make PRs against some branch other than your master branch.

yinleon · 2017-03-07T02:51:21Z

@tacaswell will do! My first commit to an OSS project, so apologies.

QuLogic · 2017-03-07T03:08:10Z

examples/axisartist/demo_axisline_style.py

        ax.axis[direction].set_visible(True)

    for direction in ["left", "right", "bottom", "top"]:
+        # hides boarders


boarders -> borders

QuLogic · 2017-03-07T03:08:45Z

examples/event_handling/pipong.py


+A matplotlib based game of Pong illustrating one way to write interactive animation which are easily ported to multiple backends pipong.py was written by Paul Ivanov <http://pirsquared.org>


matplotlib -> Matplotlib
animation -> animations
Add period at end of sentence.

Also, please wrap this line at 79 characters.

QuLogic · 2017-03-07T03:08:59Z

examples/event_handling/resample.py

+Resampling Data
+===============
+
+Downsampling lowers the sample rate or sample size of a signal. In this tutorial, the signal is downsampled when the plot is adjusted through dragging and zooming.


Wrap this line.

QuLogic · 2017-03-07T03:09:23Z

examples/mplot3d/mixed_subplots_demo.py

-Demonstrate the mixing of 2d and 3d subplots.
+============================================
+Demonstrate the mixing of 2d and 3d subplots
+============================================


Missing blank line after, I think.

I think I resolved this?

QuLogic · 2017-03-07T03:09:35Z

examples/pylab_examples/bar_stacked.py

+=================
+
+This is an example of creating a stacked bar plot with error bars using `plt.bar`.
+Note the parameters `yerr` used for error bars, and `bottom` to stack the women's bars on top of the men's bars.


Lines need to be wrapped.

QuLogic · 2017-03-07T03:09:47Z

examples/pylab_examples/dolphin.py

@@ -1,3 +1,11 @@
+"""
+=======
+Dophins


Dophins -> Dolphins

QuLogic · 2017-03-07T03:09:56Z

examples/pylab_examples/dolphin.py

+Dophins
+=======
+
+This example shows how to draw, and manipulate shapes given verticies and nodes using the patches, path and transforms classes.


QuLogic · 2017-03-07T03:10:13Z

examples/pylab_examples/fill_between_demo.py

+Filling the area between lines
+==============================
+
+This example shows how to use fill_between() to color between lines based on user-defined logic.


QuLogic · 2017-03-07T03:10:42Z

examples/pylab_examples/geo_demo.py

+======================
+
+This shows 4 possible projections using subplot.
+Matplotlib also supports the <a href='http://matplotlib.org/basemap/'>Basemaps Toolkit</a> for geographic projections.


Wrap line. Probably should mention Cartopy as well.

QuLogic · 2017-03-07T03:11:01Z

examples/pylab_examples/mri_demo.py

+MRI
+===
+
+This example illustrates how to read an image (of an MRI) into a numpy array, and display it in greyscale using `ax.imshow`.


numpy -> NumPy

Wrap line.

anntzer · 2017-03-07T03:04:33Z

examples/axisartist/demo_axisline_style.py

        ax.axis[direction].set_visible(True)

    for direction in ["left", "right", "bottom", "top"]:
+        # hides boarders


anntzer · 2017-03-07T03:05:15Z

examples/event_handling/pipong.py

-# pipong.py was written by Paul Ivanov <http://pirsquared.org>
+"""
+====
+PONG


"Pong" (I don't think it should be all caps).

anntzer · 2017-03-07T03:05:41Z

examples/pylab_examples/dolphin.py

@@ -1,3 +1,11 @@
+"""
+=======
+Dophins


anntzer · 2017-03-07T03:07:07Z

examples/axisartist/demo_axisline_style.py

@@ -1,3 +1,10 @@
+"""
+================
+Axis Line Styles


Looks like most already converted examples only capitalize the first word (which I prefer too), so let's stay consistent (applies to this and all files below).

anntzer · 2017-03-07T03:08:16Z

examples/mplot3d/mixed_subplots_demo.py

-Demonstrate the mixing of 2d and 3d subplots.
+============================================
+Demonstrate the mixing of 2d and 3d subplots
+============================================


I think I resolved this?

anntzer · 2017-03-07T03:09:39Z

examples/event_handling/pipong.py


+A matplotlib based game of Pong illustrating one way to write interactive animation which are easily ported to multiple backends pipong.py was written by Paul Ivanov <http://pirsquared.org>


Here and below, wrap your lines at 79 characters (most editors should provide some option to help that).

Here and below, use the rst syntax for hyperlinks (http://www.sphinx-doc.org/en/stable/rest.html#hyperlinks).

anntzer · 2017-03-07T03:10:33Z

examples/pylab_examples/fill_between_demo.py

+Filling the area between lines
+==============================
+
+This example shows how to use fill_between() to color between lines based on user-defined logic.


`fill_between`

(with backquotes) -- ultimately this should create a link to the API docs.

anntzer · 2017-03-07T03:12:13Z

examples/pylab_examples/dolphin.py

+Dophins
+=======
+
+This example shows how to draw, and manipulate shapes given verticies and nodes using the patches, path and transforms classes.


"vertices".

Please spell-check your docstrings.

anntzer · 2017-03-07T03:12:40Z

examples/pylab_examples/mri_demo.py

+MRI
+===
+
+This example illustrates how to read an image (of an MRI) into a numpy array, and display it in greyscale using `ax.imshow`.


just imshow

anntzer · 2017-03-07T03:13:39Z

Apparently I reviewed this at the same time as @QuLogic :-)

tacaswell · 2017-03-07T04:08:21Z

Apparently other reviewer can spell better than I can..

yinleon · 2017-03-07T05:18:21Z

thanks @anntzer and @QuLogic, you two are equally thorough :)

NelleV · 2017-03-07T06:00:08Z

examples/event_handling/pipong.py

+
+A Matplotlib based game of Pong illustrating one way to write interactive 
+animations which are easily ported to multiple backends pipong.py was written 
+by <a href='http://pirsquared.org'>Paul Ivanov</a>.


I am somewhat not surprised by the original author of that example…
ping @ivanov :D

yinleon · 2017-03-07T16:16:02Z

should I be alarmed about the Travis CLI failure? Now sure I understand what I'm seeing under Details.

afvincent · 2017-03-07T16:21:31Z

examples/event_handling/pipong.py

+Pong
+====
+
+A Matplotlib based game of Pong illustrating one way to write interactive 


Beware of the trailing whitespace (remove it for PEP8-compliance)

afvincent · 2017-03-07T16:22:08Z

examples/event_handling/pipong.py

+====
+
+A Matplotlib based game of Pong illustrating one way to write interactive 
+animations which are easily ported to multiple backends pipong.py was written 


As above, just remove the trailing whitespace for PEP8-compliance

afvincent · 2017-03-07T16:25:50Z

The Travis failure is related to PEP8 (more precisely to two trailing whitespaces). More details here ;).

Edit: typo

QuLogic · 2017-03-07T23:33:25Z

If you have changes to multiple files, editing on GitHub is not a good choice. It creates way too many single commits of one or two minor changes. Please rebase and squash this on your local copy if you can.

NelleV · 2017-03-08T01:34:06Z

Can we activate the squash and merge option? This would allow us to squash and merge before merging instead of asking contributors to rebase themselves.

ping @tacaswell

QuLogic · 2017-03-08T02:29:15Z

TBH, as a contributor, I don't really like squash&merge as it decouples your fork and upstream's (I don't like rebase&merge for the same reason.)

yinleon · 2017-03-08T06:28:08Z

Hi, I squashed all 20 commits. Did I do it correctly? Is it reflected in this PR, or should I make a new one?

NelleV · 2017-03-08T06:31:53Z

Yep, it is done and it works! Thanks!

NelleV

LGTM 👍

QuLogic · 2017-03-08T06:44:48Z

Hi, I squashed all 20 commits. Did I do it correctly? Is it reflected in this PR, or should I make a new one?

No, it's not quite right. After rebasing, you need to force push the result. If you don't force, git will complain and suggest you pull everything, but that will restore all the previous commits locally and add another merge commit.

So, please do the rebase, and then do git push --force origin master (btw, it's safer to use a feature branch instead of master) so that you can replace all the old commits.

NelleV · 2017-03-08T07:01:54Z

@yinleon Are you still around Berkeley? I was mistaken and something didn't quite happen right with the rebase. I am happy to help you out with this tomorrow (I should be at BIDS all afternoon if you are around).

yinleon · 2017-03-08T07:16:06Z

Sure thing @QuLogic.
@NelleV yes-- I will be at BIDS tomorrow.
Sorry for the confusion all.

QuLogic · 2017-03-09T07:25:03Z

examples/axisartist/demo_axisline_style.py

        ax.axis[direction].set_axisline_style("-|>")
+


There is some whitespace here causing the pep8 failure.

NelleV · 2017-03-10T23:02:23Z

Hi @yinleon
There was a small blank line issue, that I fixed.

This patch needs an additional review.

QuLogic

LGTM, but can you amend this last typo, @NelleV?

QuLogic · 2017-03-11T23:59:54Z

examples/event_handling/poly_editor.py

-matplotlib event handling to interact with objects on the canvas
+===========
+Poly Editor
+==========


One missing =.

NelleV · 2017-03-16T07:51:14Z

I think this is ready to be merged. @anntzer can you have a look at this?

anntzer · 2017-03-16T16:24:45Z

examples/event_handling/pipong.py

+====
+
+A Matplotlib based game of Pong illustrating one way to write interactive
+animations which are easily ported to multiple backends pipong.py was written


dot after "multiple backends"

anntzer · 2017-03-16T16:24:59Z

examples/event_handling/pipong.py

+
+A Matplotlib based game of Pong illustrating one way to write interactive
+animations which are easily ported to multiple backends pipong.py was written
+by <a href='http://pirsquared.org'>Paul Ivanov</a>.


hyperlinks should use rst syntax (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases)

anntzer · 2017-03-16T16:26:46Z

examples/mplot3d/lorenz_attractor.py

+
+This is an example of plotting Edward Lorenz's 1963 "Deterministic
+Nonperiodic Flow" in a 3-dimensional space using mplot3d.
+


I would suggest using an explicit hyperlink target (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-targets).

anntzer · 2017-03-16T16:28:40Z

examples/pylab_examples/bar_stacked.py

+=================
+
+This is an example of creating a stacked bar plot with error bars using
+`plt.bar`. Note the parameters `yerr` used for error bars, and `bottom`


yerr and bottom should use *foo*, not backticks (they are not references to linkable elements).

anntzer · 2017-03-16T16:31:07Z

examples/pylab_examples/dolphin.py

+========
+
+This example shows how to draw, and manipulate shapes given vertices and nodes
+using the `patches`, `path` and `transforms` classes.


Patch, Path, and Transform (references to actual python names).

anntzer · 2017-03-16T16:31:46Z

examples/pylab_examples/geo_demo.py

+
+This shows 4 possible projections using subplot.
+Matplotlib also supports
+<a href='http://matplotlib.org/basemap/'>Basemaps Toolkit</a> and


same comment as above regarding hyperlink syntax (either way works).

dstansby · 2017-04-12T11:16:13Z

This is going to take a bit of a rebase now sphinx-gallery is merged. I've assigned this to myself and will try to do it in the next day or so.

choldgraf · 2017-05-01T16:35:27Z

hey @yinleon , a lot has changed with MPL docs in the last few weeks :)

This means it'll be a bit more complicated to get this merged. Do you have time to do a live skype where you and I can spot-check these issues and get it back to a mergeable state?

dstansby · 2017-05-01T17:25:24Z

So I actually had a go at rebasing this last night, and gave up after a while. Quite a lot of the changes have already been made (titles), and there's only a couple of things that are now new unfortunately.

I think the easiest thing to do here would be to manually compare the PR diff and the current files, and just copy across anything new.

choldgraf · 2017-05-01T17:27:41Z

@phobson I think that's a good idea - let's see if @yinleon is interested in finishing this up and then we can make a plan from there

tacaswell · 2017-07-10T23:44:56Z

Closing in favor of #8860

tacaswell added this to the 2.0.1 (next bug fix release) milestone Mar 7, 2017

tacaswell reviewed Mar 7, 2017

View reviewed changes

examples/event_handling/poly_editor.py Outdated

@@ -1,4 +1,8 @@

"""

===========

Poly Editor

==========

Copy link

Member

tacaswell Mar 7, 2017

Choose a reason for hiding this comment

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

missing '='

tacaswell reviewed Mar 7, 2017

View reviewed changes

QuLogic requested changes Mar 7, 2017

View reviewed changes

anntzer requested changes Mar 7, 2017

View reviewed changes

NelleV reviewed Mar 7, 2017

View reviewed changes

dstansby added the Documentation label Mar 7, 2017

afvincent reviewed Mar 7, 2017

View reviewed changes

yinleon mentioned this pull request Mar 7, 2017

All examples should be MEP12/sphinx-gallery compliant #7206

Closed

mitchnegus mentioned this pull request Mar 8, 2017

changes to MEP12/sphinx-gallery compliant #8233

Merged

NelleV changed the title ~~changes for MEP12/sphinx-gallery compliance~~ [MRG+] changes for MEP12/sphinx-gallery compliance Mar 8, 2017

NelleV changed the title ~~[MRG+] changes for MEP12/sphinx-gallery compliance~~ [MRG+1] changes for MEP12/sphinx-gallery compliance Mar 8, 2017

NelleV approved these changes Mar 8, 2017

View reviewed changes

yinleon force-pushed the master branch from d05e80d to 5738ac2 Compare March 8, 2017 22:46

QuLogic reviewed Mar 9, 2017

View reviewed changes

DOC FIX reviewer's comments

b8e69d4

yinleon force-pushed the master branch from 5738ac2 to b8e69d4 Compare March 9, 2017 07:48

NelleV added the MEP: MEP12 gallery and examples improvements label Mar 11, 2017

FIX blank space issue for pep8

bfee1f9

NelleV force-pushed the master branch from 01e41e1 to bfee1f9 Compare March 11, 2017 08:17

QuLogic approved these changes Mar 12, 2017

View reviewed changes

DOC fixed title of poly_editor example

0374b18

NelleV changed the title ~~[MRG+1] changes for MEP12/sphinx-gallery compliance~~ [MRG+2] changes for MEP12/sphinx-gallery compliance Mar 12, 2017

anntzer requested changes Mar 16, 2017

View reviewed changes

dstansby self-assigned this Apr 12, 2017

dstansby mentioned this pull request Apr 12, 2017

changes for MEP12/sphinx-gallery compliance #8466

Closed

QuLogic modified the milestones: 2.0.1 (next bug fix release), 2.0.2 (next bug fix release) May 3, 2017

tacaswell mentioned this pull request Jul 10, 2017

Doc yinleon rebase #8860

Merged

tacaswell closed this Jul 10, 2017

QuLogic modified the milestones: 2.1 (next point release), 2.0.3 (next bug fix release) Jul 15, 2017

QuLogic changed the title ~~[MRG+2] changes for MEP12/sphinx-gallery compliance~~ changes for MEP12/sphinx-gallery compliance Jul 15, 2017

dstansby removed their assignment Jul 31, 2017


		A matplotlib based game of Pong illustrating one way to write interactive animation which are easily ported to multiple backends pipong.py was written by Paul Ivanov <http://pirsquared.org>

@@ @@ -1,3 +1,11 @@ @@
+              """
+              =======
+              Dophins


		This is an example of plotting Edward Lorenz's 1963 "Deterministic
		Nonperiodic Flow" in a 3-dimensional space using mplot3d.

changes for MEP12/sphinx-gallery compliance #8209

changes for MEP12/sphinx-gallery compliance #8209

Conversation

yinleon commented Mar 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tacaswell commented Mar 7, 2017

tacaswell commented Mar 7, 2017

yinleon commented Mar 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

QuLogic Mar 7, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anntzer commented Mar 7, 2017

tacaswell commented Mar 7, 2017

yinleon commented Mar 7, 2017

Choose a reason for hiding this comment

yinleon commented Mar 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afvincent commented Mar 7, 2017 • edited Loading

QuLogic commented Mar 7, 2017

NelleV commented Mar 8, 2017 • edited Loading

QuLogic commented Mar 8, 2017 • edited Loading

yinleon commented Mar 8, 2017

NelleV commented Mar 8, 2017

NelleV left a comment

Choose a reason for hiding this comment

QuLogic commented Mar 8, 2017 • edited Loading

NelleV commented Mar 8, 2017

yinleon commented Mar 8, 2017

Choose a reason for hiding this comment

NelleV commented Mar 10, 2017

QuLogic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NelleV commented Mar 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dstansby commented Apr 12, 2017

choldgraf commented May 1, 2017

dstansby commented May 1, 2017

choldgraf commented May 1, 2017

tacaswell commented Jul 10, 2017

QuLogic Mar 7, 2017 •

edited

Loading

afvincent commented Mar 7, 2017 •

edited

Loading

NelleV commented Mar 8, 2017 •

edited

Loading

QuLogic commented Mar 8, 2017 •

edited

Loading

QuLogic commented Mar 8, 2017 •

edited

Loading