changes for MEP12/sphinx-gallery compliance by yinleon · Pull Request #8209 · matplotlib/matplotlib · GitHub

Regarding #7206

missing '='

This seems a bit too aggressive.

Left 2 small comments, but otherwise looks good!

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

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

boarders -> borders

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

Also, please wrap this line at 79 characters.

Wrap this line.

Missing blank line after, I think.

I think I resolved this?

Lines need to be wrapped.

Dophins -> Dolphins

Wrap line.

Wrap line. Probably should mention Cartopy as well.

numpy -> NumPy

Wrap line.

borders

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

dolphins

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

blank line

I think I resolved this?

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

`fill_between`

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

"vertices".

Please spell-check your docstrings.

just imshow

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

Apparently other reviewer can spell better than I can..

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

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

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

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

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

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

Edit: typo

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.

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

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

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

Yep, it is done and it works! Thanks!

LGTM 👍

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.

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

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

There is some whitespace here causing the pep8 failure.

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

This patch needs an additional review.

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

One missing =.

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

dot after "multiple backends"

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

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

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

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

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

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.

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?

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.

@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

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

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

               """
+              ===========
+              Poly Editor
+              ==========

                       self.origYData = ydata
                       self.origXData = xdata
-                      self.ratio = 5
+                      self.ratio = 50

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

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

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

                       ax.axis[direction].set_visible(True)
                   for direction in ["left", "right", "bottom", "top"]:
+                      # hides boarders

+              PONG
+              ====
+              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>

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

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

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

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

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

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

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

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

                   for direction in ["xzero", "yzero"]:
+                      # adds arrows at the ends of each axis
                       ax.axis[direction].set_axisline_style("-|>")


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

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

changes for MEP12/sphinx-gallery compliance by yinleon · Pull Request #8209 · matplotlib/matplotlib · GitHub

Repository navigation

changes for MEP12/sphinx-gallery compliance - #8209

changes for MEP12/sphinx-gallery compliance#8209yinleon wants to merge 4 commits intomatplotlib:mastermatplotlib/matplotlib:masterfrom yinleon:masteryinleon/matplotlib:masterCopy head branch name to clipboard

Conversation

yinleon commented Mar 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Mar 7, 2017

Uh oh!

tacaswell commented Mar 7, 2017

Uh oh!

yinleon commented Mar 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuLogic Mar 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer commented Mar 7, 2017

Uh oh!

tacaswell commented Mar 7, 2017

Uh oh!

yinleon commented Mar 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yinleon commented Mar 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

afvincent commented Mar 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changes for MEP12/sphinx-gallery compliance#8209
yinleon wants to merge 4 commits into
matplotlib:masterfrom
yinleon:master

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