[wip] Doc cleanup for examples/color/color_cycle and examples/animation/animated_histogram #8890

johnh2o2 · 2017-07-15T22:34:06Z

PR Summary

Scipy 2017 sprint! Working on improving the documentation with better
sphinx-gallery integration. I've added some more documentation to
the examples/animation/animated_histogram and the examples/color/color_cycle sections. I've also moved the color_cycle from examples/color to tutorials/02_Intermediate, since it seemed more like something users would be interested in doing regularly, and I've worded it more like a tutorial. Not sure how people feel about that.

PR Checklist

[n/a] Has Pytest style unit tests
Code is PEP 8 compliant
[n/a] New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
[n/a] Added an entry to doc/users/whats_new.rst if major new feature
[n/a] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

johnh2o2 · 2017-07-15T22:39:33Z

This also addresses the doc issues in #8885 @choldgraf

choldgraf · 2017-07-16T19:49:35Z

Nice! I'll give it a look when I'm back in Berkeley and will give some comments!

(if you're looking for something to work on quickly, I noticed that you use single tickmarks for comments, while rST uses double backticks (``). Also make sure that you've always got whitespace around operators (e.g.,a = 2 + 2, not a = 2+2)

choldgraf · 2017-07-21T22:05:22Z

examples/animation/histogram.py

-# it to keep the codes aligned with the vertices
+###############################################################################
+# Here comes the tricky part -- we have to set up the vertex and path codes
+# arrays using `plt.Path.MOVETO`, `plt.Path.LINETO` and `plt.Path.CLOSEPOLY`


`` double backticks for rST (do this here and in all subsequent uses of backticks)

choldgraf · 2017-07-21T22:05:50Z

examples/animation/histogram.py

+#   v4 to our initial vertex (the `MOVETO` vertex), in order to close the
+#   polygon.
+#
+# Note: the vertex for `CLOSEPOLY` is ignored, but we still need a placeholder


this could be .. note::

choldgraf · 2017-07-21T22:07:01Z

tutorials/02_intermediate/color_cycle.py

+# First we'll generate some sample data, in this case, four offset sine
+# curves.
+x = np.linspace(0, 2 * np.pi, 50)
+offsets = np.linspace(0, 2*np.pi, 4, endpoint=False)


spaces around the *

choldgraf · 2017-07-21T22:07:20Z

tutorials/02_intermediate/color_cycle.py

+print(yy.shape)
+
+###############################################################################
+# So `yy[:,i]` will give you the `i`-th offset sine curve. Let's set the


space after :, (sorry I'm being persnickety about this)

choldgraf · 2017-07-21T22:07:56Z

tutorials/02_intermediate/color_cycle.py

+
+###############################################################################
+# So `yy[:,i]` will give you the `i`-th offset sine curve. Let's set the
+# default prop_cycle using `plt.rc`. We'll combine a color cycler and a


here could you try linking to rc with an rST :func: (or maybe just a :ref: since I believe rc isn't actually a function)? I think that'll make it link nicely in the docs

choldgraf · 2017-07-21T22:08:58Z

tutorials/02_intermediate/color_cycle.py

+ax0.plot(yy)
+ax0.set_title('Set default color cycle to rgby')
+
+###############################################################################


We probably don't want the line of ###### here since we're plotting on the same figure

just to clarify, in general we shouldn't split a single figure between two ####### blocks of code

choldgraf · 2017-07-21T22:10:42Z

Just had a closer look - it looks really nice. A few styling comments to take care of and then once the tests pass I'm +1. Lemme know when you take care of that @johnh2o2

WeatherGod · 2017-08-05T02:10:13Z

Ping! This definitely would be a nice improvement to have. Let us know if you are having difficulties with rebasing.

Remove start_event_loop_default. Let pause() run the event loop for all backends.

Fix matplotlib corrupting PySide

Fix osx busy cursor

- put draw_idle in the base canvas resize event - re-order our resize handling and Qt's resize handling (let Qt go first) - do not call processEvents from inside of the paint event (this maybe the critical fix)

CI: Tweak conda installation on appveyor

Convert tick-setting methods to docstrings

Don't fail on empty autoscale_None.

Convert tick-setting methods to docstrings

choldgraf · 2017-10-09T17:20:38Z

pinging @johnh2o2 :-)

* deleted circled in green * deleted space * removed blue box

Errorbar bugfix

Update doc strings

DOC: Add descriptions for remaining event handling examples

Fix typo of pixels in legend_handler.py

Update descriptions for images_contours_and_fields

FIX: poorly done deprecation in image.py.

Fix edgecolor being only applied to first bar.

… to tutorials, edit to animations/histogram

…holdgraf

…holdgraf

…ow. Edited whats_new_1.5.rst to reflect changed location of the color_cycle.py from color/ to tutorials/02_intermediate

…termediate folder

johnh2o2 · 2017-10-11T17:45:42Z

Hey @choldgraf , so I'm not sure that I've done things correctly with the rebasing....I apologize if I've caused more problems...

(I THINK) I've rebased with the upstream/master branch, but now running python make.py --allowsphinxwarnings html gives me a number of warnings about unreferenced documentation:

checking consistency... /Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/lines_bars_and_markers/scatter_profile.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/agg_buffer.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/agg_buffer_to_array.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/anchored_artists.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/anscombe.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/arctest.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/arrow_demo.rst: WARNING: document isn't included in any toctree
/Users/jah5/Documents/scipy2017/sprints/matplotlib/doc/gallery/pylab_examples/arrow_simple_demo.rst: WARNING: document isn't included in any toctree
...

Not sure if this is a result of failed rebasing or if these are acceptable warnings or what. Let me know what I should (or shouldn't) do on my end.

Thanks!

John

choldgraf · 2017-10-11T18:09:42Z

whoah! it looks like there are now 636 files changed so that is almost certainly not correct haha. To be honest I think your best bet is to copy the test from the example that you've added (AKA the changes that were part of this initial PR), and start from scratch. I know that's a pain but it sounds like something very strange happened with the rebase.

How did you do the rebase? The correct commands from your fork would have been:

git checkout master
git pull upstream master
git checkout doc-improvements
git rebase master

choldgraf · 2017-10-15T21:36:51Z

closed via #9408 ...thanks @johnh2o2 !!!

tacaswell added this to the 2.1 (next point release) milestone Jul 16, 2017

tacaswell added the Documentation label Jul 16, 2017

choldgraf reviewed Jul 21, 2017

View reviewed changes

choldgraf mentioned this pull request Jul 21, 2017

scipy2017 sprint - docs #8885

Closed

4 tasks

tacaswell modified the milestones: 2.1 (next point release), 2.2 (next next feature release) Aug 29, 2017

efiring and others added 13 commits September 18, 2017 15:08

Merge pull request #8867 from anntzer/eventloop

35af6c0

Remove start_event_loop_default. Let pause() run the event loop for all backends.

Merge pull request #9169 from t20100/fix-restore-init-pyside

4b50e49

Fix matplotlib corrupting PySide

Merge pull request #9169 from t20100/fix-restore-init-pyside

6ab5288

Fix matplotlib corrupting PySide

TST: add test for pandas + pcolormesh

e12db84

Merge pull request #9157 from dstansby/osx-busy-cursor

63e2810

Fix osx busy cursor

FIX: qt recursive draw

7ff959c

- put draw_idle in the base canvas resize event - re-order our resize handling and Qt's resize handling (let Qt go first) - do not call processEvents from inside of the paint event (this maybe the critical fix)

Merge pull request #9197 from dstansby/appveyor

ebd3a72

CI: Tweak conda installation on appveyor

Minor fixes to tick docstrings

b4acccf

Merge pull request #9192 from dstansby/set-tick-docstrings

0817c66

Convert tick-setting methods to docstrings

get proper renderer width and height in FigureImage

ed44f27

Merge pull request #9195 from anntzer/empty-lognorm

b4788ba

Don't fail on empty autoscale_None.

Merge pull request #9192 from dstansby/set-tick-docstrings

172daf8

Convert tick-setting methods to docstrings

get proper renderer width and height in FigureImage

fb01a91

anntzer and others added 22 commits October 9, 2017 11:01

Fix poorly done deprecations in image.py.

d46aefb

Axis user guide (#9323)

f34627d

* deleted circled in green * deleted space * removed blue box

Merge pull request #9242 from astromancer/errorbar-bugfix

5a0d489

Errorbar bugfix

TST: add test of deprecated properties

05b5759

Add descriptions for remaining event handling examples

e331717

Merge pull request #9279 from ImportanceOfBeingErnest/patch-2

c166fa1

Update doc strings

Merge pull request #9333 from divyam3897/descriptionExamples

28ae8eb

DOC: Add descriptions for remaining event handling examples

Fix typo of pixels

1bccf3c

Merge pull request #9342 from deepyaman/fix-typo

383091a

Fix typo of pixels in legend_handler.py

Update descriptions for images_contours_and_fields

10eff27

Merge pull request #9341 from divyam3897/updateDescriptions

4ccfccb

Update descriptions for images_contours_and_fields

Document alternative to iterpnames.

3777136

Merge pull request #9335 from anntzer/figureoptions-fix

ad730d1

FIX: poorly done deprecation in image.py.

Fix edgecolor being only applied to first bar.

7ff9287

Merge pull request #9353 from anntzer/bar-edgecolor-cycle

95805d2

Fix edgecolor being only applied to first bar.

minor documentation changes, color_cycle has been moved from examples…

872dd49

… to tutorials, edit to animations/histogram

added rst note for link to external cycler api in the color_cycle docs

faa41af

put plt.show() back in

07cfaf7

wip: fixed some rST formatting and included changes recommended by @c…

6df56da

…holdgraf

wip: fixed more rST errors, python make.py html runs without errors n…

ee36b78

…ow. Edited whats_new_1.5.rst to reflect changed location of the color_cycle.py from color/ to tutorials/02_intermediate

renamed 02_intermediate reference in whats_new_1.5.rst, deleted 02_in…

ca5cf03

…termediate folder

wip: fixed merge conflicts from origin branch

89b9ffb

choldgraf mentioned this pull request Oct 15, 2017

updating color cycle tutorial #9408

Merged

choldgraf closed this Oct 15, 2017

QuLogic modified the milestones: v2.2, v2.1.0-doc Oct 15, 2017

Uh oh!

[wip] Doc cleanup for examples/color/color_cycle and examples/animation/animated_histogram #8890

[wip] Doc cleanup for examples/color/color_cycle and examples/animation/animated_histogram #8890

Uh oh!

Conversation

johnh2o2 commented Jul 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

johnh2o2 commented Jul 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

choldgraf commented Jul 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

choldgraf Jul 21, 2017

Choose a reason for hiding this comment

Uh oh!

choldgraf Jul 21, 2017

Choose a reason for hiding this comment

Uh oh!

choldgraf Jul 21, 2017

Choose a reason for hiding this comment

Uh oh!

choldgraf Jul 21, 2017

Choose a reason for hiding this comment

Uh oh!

choldgraf Jul 21, 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!

choldgraf Jul 21, 2017

Choose a reason for hiding this comment

Uh oh!

choldgraf Jul 21, 2017

Choose a reason for hiding this comment

Uh oh!

choldgraf commented Jul 21, 2017

Uh oh!

WeatherGod commented Aug 5, 2017

Uh oh!

choldgraf commented Oct 9, 2017

Uh oh!

johnh2o2 commented Oct 11, 2017

Uh oh!

choldgraf commented Oct 11, 2017

Uh oh!

choldgraf commented Oct 15, 2017

Uh oh!

Uh oh!

johnh2o2 commented Jul 15, 2017 •

edited

Loading

johnh2o2 commented Jul 15, 2017 •

edited

Loading

choldgraf commented Jul 16, 2017 •

edited

Loading

choldgraf Jul 21, 2017 •

edited

Loading