Adding headers for examples/units for MEP12/sphinx-gallery compliance #8254

yinleon · 2017-03-10T04:10:07Z

Changes in accordance to #7206

dstansby

Just some small changes to make, otherwise this all looks good 👍

dstansby · 2017-03-10T11:15:38Z

examples/units/artist_tests.py

+============
+Artist tests
+============
+
 Test unit support with each of the matplotlib primitive artist types


Could you put a full stop at the end of this sentence?

Also capitalize Matplotlib if you change this line.

dstansby · 2017-03-10T11:15:41Z

examples/units/artist_tests.py

+============
+Artist tests
+============
+
 Test unit support with each of the matplotlib primitive artist types

 The axes handles unit conversions and the artists keep a pointer to


axes --> axis

dstansby · 2017-03-10T11:15:43Z

examples/units/artist_tests.py

+============
+Artist tests
+============
+
 Test unit support with each of the matplotlib primitive artist types

 The axes handles unit conversions and the artists keep a pointer to
 their axes parent, so you must init the artists with the axes instance


axes --> axis

I would change this 'init' to the full 'initialize'...

dstansby · 2017-03-10T11:16:35Z

examples/units/bar_demo2.py

+===================
+Bar demo with units
+===================
+
 plot using a variety of cm vs inches conversions.  The example shows


plot --> Plot

Also, spell out centimetre (inches is not abbreviated).

dstansby · 2017-03-10T11:18:51Z

examples/units/bar_unit_demo.py

+=========================
+
+This is the same example as
+<a href='http://matplotlib.org/examples/api/barchart_demo.html'>


I think there is probably a better way of linking between examples instead of using a hyperlink, but I can't think of how to at the moment.

I don't think this works. Once we'll finish the migration to sphinx gallery, rst markup will work.

dstansby · 2017-03-10T11:20:01Z

examples/units/radian_demo.py

+============
+Radian ticks
+============
+
 Plot with radians from the basic_units mockup example package


Could you add a full stop and a newline at the end of the first sentence?

QuLogic

In line with @dstansby's comments, these are not exactly comments on what you've done, but general improvements, really. Depends on how much work you want to do...

QuLogic · 2017-03-10T23:37:45Z

examples/units/artist_tests.py

+============
+Artist tests
+============
+
 Test unit support with each of the matplotlib primitive artist types


Also capitalize Matplotlib if you change this line.

QuLogic · 2017-03-10T23:38:28Z

examples/units/artist_tests.py

+============
+Artist tests
+============
+
 Test unit support with each of the matplotlib primitive artist types

 The axes handles unit conversions and the artists keep a pointer to
 their axes parent, so you must init the artists with the axes instance


I would change this 'init' to the full 'initialize'...

QuLogic · 2017-03-10T23:39:21Z

examples/units/artist_tests.py

+============
+Artist tests
+============
+
 Test unit support with each of the matplotlib primitive artist types

 The axes handles unit conversions and the artists keep a pointer to
 their axes parent, so you must init the artists with the axes instance
 if you want to initialize them with unit data, or else they will not


... and 'initialize them with unit data' to 'use them with unit data'.

QuLogic · 2017-03-10T23:40:01Z

examples/units/artist_tests.py

@@ -34,13 +38,15 @@
    ax.add_collection(lc)

 # test a plain-ol-line
-line = lines.Line2D([0*cm, 1.5*cm], [0*cm, 2.5*cm], lw=2, color='black', axes=ax)
+line = lines.Line2D(
+    [0*cm, 1.5*cm], [0*cm, 2.5*cm], lw=2, color='black', axes=ax)


If this is too long, I'd break after the positional arguments instead; this doesn't look that great.

QuLogic · 2017-03-10T23:40:08Z

examples/units/artist_tests.py

 ax.add_line(line)

 if 0:
    # test a patch
    # Not supported at present.
-    rect = patches.Rectangle((1*cm, 1*cm), width=5*cm, height=2*cm, alpha=0.2, axes=ax)
+    rect = patches.Rectangle(
+        (1*cm, 1*cm), width=5*cm, height=2*cm, alpha=0.2, axes=ax)


QuLogic · 2017-03-10T23:40:46Z

examples/units/bar_demo2.py

+===================
+Bar demo with units
+===================
+
 plot using a variety of cm vs inches conversions.  The example shows


Also, spell out centimetre (inches is not abbreviated).

QuLogic · 2017-03-10T23:40:59Z

examples/units/bar_demo2.py

+===================
+Bar demo with units
+===================
+
 plot using a variety of cm vs inches conversions.  The example shows
 how default unit instrospection works (ax1), how various keywords can


instrospection -> introspection

QuLogic · 2017-03-11T00:18:25Z

examples/units/evans_test.py

@@ -1,8 +1,13 @@
 """
+==========
+Evans test


Who or what is "Evans"? Does anyone know? @tacaswell? I think this needs a different name.

This all predates me. I assume someone from JPL

NelleV

LGTM
Thanks @yinleon !

dstansby · 2017-03-25T16:13:15Z

Cool, going to merge this in to get the titles in ready for sphinx-gallery, and open a new PR with the suggested cleanups. Thanks for the PR @yinleon !

NelleV · 2017-03-25T16:27:35Z

wohoo! This section did not appear in our gallery. I'm going to try to add to the sphinx-gallery one.

Adding headers for examples/units for MEP12/sphinx-gallery compliance

dstansby · 2017-03-25T18:41:46Z

Backported to 2.0.x via. 932d469

added headers for sphinx compliance

39d9800

dstansby added the Documentation label Mar 10, 2017

dstansby requested changes Mar 10, 2017

View reviewed changes

dstansby mentioned this pull request Mar 10, 2017

[DOC] Clean up bar_demo2 #8256

Merged

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

QuLogic reviewed Mar 11, 2017

View reviewed changes

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

NelleV approved these changes Mar 11, 2017

View reviewed changes

NelleV changed the title ~~Adding headers for examples/units for MEP12/sphinx-gallery compliance~~ [MRG+1] Adding headers for examples/units for MEP12/sphinx-gallery compliance Mar 11, 2017

dstansby changed the title ~~[MRG+1] Adding headers for examples/units for MEP12/sphinx-gallery compliance~~ Adding headers for examples/units for MEP12/sphinx-gallery compliance Mar 25, 2017

dstansby merged commit 98ce210 into matplotlib:master Mar 25, 2017

dstansby added the Needs backport label Mar 25, 2017

dstansby mentioned this pull request Mar 25, 2017

Clean up unit examples #8377

Merged

dstansby added a commit that referenced this pull request Mar 25, 2017

Merge pull request #8254 from yinleon/units

932d469

Adding headers for examples/units for MEP12/sphinx-gallery compliance

dstansby removed the Needs backport label Mar 25, 2017

Uh oh!

Adding headers for examples/units for MEP12/sphinx-gallery compliance #8254

Adding headers for examples/units for MEP12/sphinx-gallery compliance #8254

Uh oh!

Conversation

yinleon commented Mar 10, 2017

Uh oh!

dstansby left a comment

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!

QuLogic left a comment

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!

NelleV left a comment

Choose a reason for hiding this comment

Uh oh!

dstansby commented Mar 25, 2017

Uh oh!

NelleV commented Mar 25, 2017

Uh oh!

dstansby commented Mar 25, 2017

Uh oh!

Uh oh!