MEP12 API examples #7439

Merged
merged 2 commits into from Nov 11, 2016

Conversation

Projects
None yet
3 participants
Contributor

NelleV commented Nov 11, 2016

MEP12-ifying API examples.

Related to #7206

@NelleV NelleV MEP12 API examples
5cba273

NelleV added this to the 2.1 (next point release) milestone Nov 11, 2016

@QuLogic

Several minor tweaks.

examples/api/bbox_intersect.py
+Changing colors of lines intersecting a box
+===========================================
+
+The lines interescting the rectangle are colored in red, while the other one
@QuLogic

QuLogic Nov 11, 2016 edited

Member

interescting -> intersecting
other one -> others

examples/api/collections_demo.py
-RegularPolyCollection with autoscaling.
+'''
+=========================================================
+Line and Poly and RegularPoly Collection with autoscaling
@QuLogic

QuLogic Nov 11, 2016

Member

Line, Poly, and ...

examples/api/colorbar_basics.py
+Colorbar
+========
+
+This example shows how to use colorbar by specify the mappable object (here
@QuLogic

QuLogic Nov 11, 2016

Member

specify -> specifying

examples/api/compound_path.py
+Compound path
+=============
+
+Make a compound path -- in this case two simple polygons, a rectangle
and a triangle. Use CLOSEOPOLY and MOVETO for the different parts of
@QuLogic

QuLogic Nov 11, 2016

Member

There's an existing typo here; should be CLOSEPOLY.

+Custom projection
+=================
+
+This example showcases the Hammer projection by alleviating many features of
@QuLogic

QuLogic Nov 11, 2016

Member

I don't think alleviating is the right verb here; not sure what it's trying to say (utilizing/using would fit without changing the sentence, but doesn't quite imply the same things.)

@QuLogic

QuLogic Nov 11, 2016

Member

Missed this one.

examples/api/date_index_formatter.py
@@ -1,4 +1,8 @@
"""
+====================================
+Custom tick formatter for timeseries
@QuLogic

QuLogic Nov 11, 2016

Member

timeseries -> time series
or change the description to match.

examples/api/date_index_formatter.py
+====================================
+Custom tick formatter for timeseries
+====================================
+
When plotting time series, e.g., financial time series, one often wants
to leave out days on which there is no data, eh weekends. The example
@QuLogic

QuLogic Nov 11, 2016

Member

The existing "eh" here is probably not someone being Canadian... Probably should be "e.g.," or maybe "i.e.,".

examples/api/engineering_formatter.py
@@ -1,4 +1,8 @@
'''
+=========================================
+Labeling ticks using engineering notations
@QuLogic

QuLogic Nov 11, 2016

Member

notations -> notation

examples/api/filled_step.py
@@ -1,3 +1,12 @@
+"""
+=========================
+Hatched filled histograms
@QuLogic

QuLogic Nov 11, 2016

Member

Hatched filled -> Hatch-filled

examples/api/mathtext_asarray.py
+A mathtext image as numpy array
+===============================
+
+This example shows how to make images from latex strings.
@QuLogic

QuLogic Nov 11, 2016

Member

latex -> LaTeX

examples/api/quad_bezier.py
+Bezier Curve
+============
+
+This example showcases the PathPatch object to create a bezier polycurve path
@QuLogic

QuLogic Nov 11, 2016

Member

bezier -> Bezier (or even better to include the accent Bézier)

examples/api/radar_chart.py
@@ -1,5 +1,9 @@
"""
-Example of creating a radar chart (a.k.a. a spider or star chart) [1]_.
+=====================================
+Radar chart (aka spider or star chart
@QuLogic

QuLogic Nov 11, 2016

Member

Closing parenthesis missing.

examples/api/sankey_demo_old.py
@@ -1,3 +1,11 @@
+"""
+========================
+Yet another Sankey chart
@QuLogic

QuLogic Nov 11, 2016

Member

chart -> diagram

-"""Demonstrate the Sankey class by producing three basic diagrams.
+"""
+================
+The Sankey class
@QuLogic

QuLogic Nov 11, 2016

Member

50/50 on changing class to diagram here too.

examples/api/sankey_demo_rankine.py
-"""Demonstrate the Sankey class with a practicle example of a Rankine power
+"""
+===================
+Rankine power Cycle
@QuLogic

QuLogic Nov 11, 2016

Member

Cycle -> cycle

examples/api/sankey_demo_rankine.py
+Rankine power Cycle
+===================
+
+Demonstrate the Sankey class with a practicle example of a Rankine power
@QuLogic

QuLogic Nov 11, 2016

Member

practicle -> practical

examples/api/scatter_piecharts.py
@@ -1,5 +1,9 @@
"""
-This example makes custom 'pie charts' as the markers for a scatter plotqu
+====================================
+Scatter plot with pie charts markers
@QuLogic

QuLogic Nov 11, 2016

Member

charts -> chart

@NelleV NelleV FIX reviewer's comments
e00ee31
Contributor

NelleV commented Nov 11, 2016

Comments are addressed.

Owner

tacaswell commented Nov 11, 2016

appveyor failure is network related.

@tacaswell tacaswell merged commit a07af2d into matplotlib:master Nov 11, 2016

2 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 61.839%
Details

@tacaswell tacaswell added a commit that referenced this pull request Nov 11, 2016

@tacaswell tacaswell Merge pull request #7439 from NelleV/MEP12_api
DOC: MEP12 API examples
a1b680b
Owner

tacaswell commented Nov 11, 2016

backported to v2.x as a1b680b

Owner

tacaswell commented Nov 11, 2016

Thanks @NelleV

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment