matplotlib · tacaswell · Nov 11, 2016 · Nov 11, 2016 · Nov 11, 2016 · QuLogic
diff --git a/examples/api/agg_oo.py b/examples/api/agg_oo.py
@@ -1,5 +1,9 @@
 # -*- noplot -*-
 """
+=============================
+The object-oriented interface
+=============================
+
 A pure OO (look Ma, no pylab!) example using the agg backend
 """
 from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas

diff --git a/examples/api/barchart_demo.py b/examples/api/barchart_demo.py
@@ -1,4 +1,8 @@
 """
+========
+Barchart
+========
+
 A bar plot with errorbars and height labels on individual bars
 """
 import numpy as np

diff --git a/examples/api/bbox_intersect.py b/examples/api/bbox_intersect.py
@@ -1,3 +1,13 @@
+"""
+===========================================
+Changing colors of lines intersecting a box
+===========================================
+
+The lines intersecting the rectangle are colored in red, while the others
+are left as blue lines. This example showcases the `intersect_bbox` function.
+
+"""
+
 import numpy as np
 import matplotlib.pyplot as plt
 from matplotlib.transforms import Bbox

diff --git a/examples/api/collections_demo.py b/examples/api/collections_demo.py
@@ -1,5 +1,7 @@
-'''Demonstration of LineCollection, PolyCollection, and
-RegularPolyCollection with autoscaling.
+'''
+=========================================================
+Line, Poly and RegularPoly Collection with autoscaling
+=========================================================
 
 For the first two subplots, we will use spirals.  Their
 size will be set in plot units, not data units.  Their positions

diff --git a/examples/api/colorbar_basics.py b/examples/api/colorbar_basics.py
@@ -1,3 +1,12 @@
+"""
+========
+Colorbar
+========
+
+This example shows how to use colorbar by specifying the mappable object (here
+the imshow returned object) and the axes to attach the colorbar to.
+"""
+
 import numpy as np
 import matplotlib.pyplot as plt
 

diff --git a/examples/api/colorbar_only.py b/examples/api/colorbar_only.py
@@ -1,5 +1,9 @@
 '''
-Make a colorbar as a separate figure.
+====================
+Customized colorbars
+====================
+
+This example shows how to build colorbars without an attached mappable.
 '''
 
 import matplotlib.pyplot as plt

diff --git a/examples/api/compound_path.py b/examples/api/compound_path.py
@@ -1,6 +1,10 @@
 """
-Make a compund path -- in this case two simple polygons, a rectangle
-and a triangle.  Use CLOSEOPOLY and MOVETO for the different parts of
+=============
+Compound path
+=============
+
+Make a compound path -- in this case two simple polygons, a rectangle
+and a triangle.  Use CLOSEPOLY and MOVETO for the different parts of
 the compound path
 """
 import numpy as np

diff --git a/examples/api/custom_projection_example.py b/examples/api/custom_projection_example.py
@@ -1,3 +1,13 @@
+"""
+=================
+Custom projection
+=================
+
+This example showcases the Hammer projection by alleviating many features of
+matplotlib.
+"""
+
+
 from __future__ import unicode_literals
 
 import matplotlib

diff --git a/examples/api/custom_scale_example.py b/examples/api/custom_scale_example.py
@@ -1,3 +1,13 @@
+"""
+============
+Custom scale
+============
+
+This example showcases how to create a custom scale, by implementing the
+scaling use for latitude data in a Mercator Projection.
+"""
+
+
 from __future__ import unicode_literals
 
 import numpy as np

diff --git a/examples/api/date_demo.py b/examples/api/date_demo.py
@@ -1,4 +1,8 @@
 """
+================
+Date tick labels
+================
+
 Show how to make date plots in matplotlib using date tick locators and
 formatters.  See major_minor_demo1.py for more information on
 controlling major and minor ticks

diff --git a/examples/api/date_index_formatter.py b/examples/api/date_index_formatter.py
@@ -1,6 +1,10 @@
 """
+=====================================
+Custom tick formatter for time series
+=====================================
+
 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
+to leave out days on which there is no data, i.e. weekends.  The example
 below shows how to use an 'index formatter' to achieve the desired plot
 """
 from __future__ import print_function
@@ -19,8 +23,10 @@
 
 
 # first we'll do it the default way, with gaps on weekends
-fig, ax = plt.subplots()
+fig, axes = plt.subplots(ncols=2, figsize=(8, 4))
+ax = axes[0]
 ax.plot(r.date, r.adj_close, 'o-')
+ax.set_title("Default")
 fig.autofmt_xdate()
 
 # next we'll write a custom formatter
@@ -32,9 +38,10 @@ def format_date(x, pos=None):
     thisind = np.clip(int(x + 0.5), 0, N - 1)
     return r.date[thisind].strftime('%Y-%m-%d')
 
-fig, ax = plt.subplots()
+ax = axes[1]
 ax.plot(ind, r.adj_close, 'o-')
 ax.xaxis.set_major_formatter(ticker.FuncFormatter(format_date))
+ax.set_title("Custom tick formatter")
 fig.autofmt_xdate()
 
 plt.show()
diff --git a/examples/api/demo_affine_image.py b/examples/api/demo_affine_image.py
@@ -1,4 +1,8 @@
 """
+============================
+Affine transform of an image
+============================
+
 For the backends that support draw_image with optional affine
 transform (e.g., agg, ps backend), the image of the output should
 have its boundary match the dashed yellow rectangle.

diff --git a/examples/api/donut_demo.py b/examples/api/donut_demo.py
@@ -1,3 +1,11 @@
+"""
+=============
+Mmh Donuts!!!
+=============
+
+This example draws donuts (miam!) using Path and Patches.
+"""
+
 import numpy as np
 import matplotlib.path as mpath
 import matplotlib.patches as mpatches

diff --git a/examples/api/engineering_formatter.py b/examples/api/engineering_formatter.py
@@ -1,4 +1,8 @@
 '''
+=========================================
+Labeling ticks using engineering notation
+=========================================
+
 Demo to show use of the engineering Formatter.
 '''
 

diff --git a/examples/api/filled_step.py b/examples/api/filled_step.py
@@ -1,3 +1,12 @@
+"""
+=========================
+Hatch-filled histograms
+=========================
+
+This example showcases the hatching capabilities of matplotlib by plotting
+various histograms.
+"""
+
 import itertools
 from collections import OrderedDict
 from functools import partial

diff --git a/examples/api/font_family_rc.py b/examples/api/font_family_rc.py
@@ -1,4 +1,8 @@
 """
+===========================
+Configuring the font family
+===========================
+
 You can explicitly set which font family is picked up for a given font
 style (e.g., 'serif', 'sans-serif', or 'monospace').
 

diff --git a/examples/api/font_file.py b/examples/api/font_file.py
@@ -1,5 +1,9 @@
 # -*- noplot -*-
 """
+===================================
+Using a ttf font file in matplotlib
+===================================
+
 Although it is usually not a good idea to explicitly point to a single
 ttf file for a font instance, you can do so using the
 font_manager.FontProperties fname argument (for a more flexible

diff --git a/examples/api/histogram_path_demo.py b/examples/api/histogram_path_demo.py
@@ -1,4 +1,8 @@
 """
+========================================================
+Building histograms using Rectangles and PolyCollections
+========================================================
+
 This example shows how to use a path patch to draw a bunch of
 rectangles.  The technique of using lots of Rectangle instances, or
 the faster method of using PolyCollections, were implemented before we
@@ -41,7 +45,7 @@
 barpath = path.Path.make_compound_path_from_polys(XY)
 
 # make a patch out of it
-patch = patches.PathPatch(barpath, facecolor='blue')
+patch = patches.PathPatch(barpath)
 ax.add_patch(patch)
 
 # update the view limits

diff --git a/examples/api/image_zcoord.py b/examples/api/image_zcoord.py
@@ -1,10 +1,13 @@
 """
+==================================
+Modifying the coordinate formatter
+==================================
+
 Show how to modify the coordinate formatter to report the image "z"
 value of the nearest pixel given x and y
 """
 import numpy as np
 import matplotlib.pyplot as plt
-import matplotlib.cm as cm
 
 # Fixing random state for reproducibility
 np.random.seed(19680801)

diff --git a/examples/api/joinstyle.py b/examples/api/joinstyle.py
@@ -1,4 +1,8 @@
 """
+===========
+Join styles
+===========
+
 Illustrate the three different join styles
 """
 

diff --git a/examples/api/legend_demo.py b/examples/api/legend_demo.py
@@ -1,3 +1,12 @@
+"""
+===============================
+Legend using pre-defined labels
+===============================
+
+Notice how the legend labels are defined with the plots!
+"""
+
+
 import numpy as np
 import matplotlib.pyplot as plt
 

diff --git a/examples/api/line_with_text.py b/examples/api/line_with_text.py
@@ -1,4 +1,8 @@
 """
+=======================
+Artist within an artist
+=======================
+
 Show how to override basic methods so an artist can contain another
 artist.  In this case, the line contains a Text instance to label it.
 """

diff --git a/examples/api/logo2.py b/examples/api/logo2.py
@@ -1,4 +1,8 @@
 """
+==========
+matplotlib
+==========
+
 Thanks to Tony Yu <tsyu80@gmail.com> for the logo design
 """
 
@@ -13,7 +17,6 @@
 
 
 axalpha = 0.05
-#figcolor = '#EFEFEF'
 figcolor = 'white'
 dpi = 80
 fig = plt.figure(figsize=(6, 1.1), dpi=dpi)
@@ -37,8 +40,6 @@ def add_math_background():
                  (0.35, 0.9), 20))
     text.append((r"$\int_{-\infty}^\infty e^{-x^2}dx=\sqrt{\pi}$",
                  (0.15, 0.3), 25))
-    #text.append((r"$E = mc^2 = \sqrt{{m_0}^2c^4 + p^2c^2}$",
-    #            (0.7, 0.42), 30))
     text.append((r"$F_G = G\frac{m_1m_2}{r^2}$",
                  (0.85, 0.7), 30))
     for eq, (x, y), size in text:
@@ -80,6 +81,7 @@ def add_polar_bar():
     ax.set_yticks(np.arange(1, 9, 2))
     ax.set_rmax(9)
 
+
 if __name__ == '__main__':
     main_axes = add_math_background()
     add_polar_bar()

diff --git a/examples/api/mathtext_asarray.py b/examples/api/mathtext_asarray.py
@@ -1,5 +1,9 @@
 """
-Load a mathtext image as numpy array
+===============================
+A mathtext image as numpy array
+===============================
+
+This example shows how to make images from LaTeX strings.
 """
 
 import matplotlib.mathtext as mathtext

diff --git a/examples/api/patch_collection.py b/examples/api/patch_collection.py
@@ -1,3 +1,9 @@
+"""
+============================
+Circles, Wedges and Polygons
+============================
+"""
+
 import numpy as np
 import matplotlib
 from matplotlib.patches import Circle, Wedge, Polygon

diff --git a/examples/api/power_norm_demo.py b/examples/api/power_norm_demo.py
@@ -1,3 +1,12 @@
+"""
+========================
+Exploring normalizations
+========================
+
+Let's explore various normalization on a multivariate normal distribution.
+
+"""
+
 from matplotlib import pyplot as plt
 import matplotlib.colors as mcolors
 import numpy as np

diff --git a/examples/api/quad_bezier.py b/examples/api/quad_bezier.py
@@ -1,3 +1,12 @@
+"""
+============
+Bezier Curve
+============
+
+This example showcases the PathPatch object to create a Bezier polycurve path
+patch.
+"""
+
 import matplotlib.path as mpath
 import matplotlib.patches as mpatches
 import matplotlib.pyplot as plt

diff --git a/examples/api/radar_chart.py b/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)
+======================================
+
+This example creates a radar chart, also known as a spider or star chart [1]_.
 
 Although this example allows a frame of either 'circle' or 'polygon', polygon
 frames don't have proper gridlines (the lines are circles instead of polygons).
@@ -187,7 +191,8 @@ def example_data():
     # add legend relative to top-left plot
     ax = axes[0, 0]
     labels = ('Factor 1', 'Factor 2', 'Factor 3', 'Factor 4', 'Factor 5')
-    legend = ax.legend(labels, loc=(0.9, .95), labelspacing=0.1, fontsize='small')
+    legend = ax.legend(labels, loc=(0.9, .95),
+                       labelspacing=0.1, fontsize='small')
 
     fig.text(0.5, 0.965, '5-Factor Solution Profiles Across Four Scenarios',
              horizontalalignment='center', color='black', weight='bold',

diff --git a/examples/api/sankey_demo_basics.py b/examples/api/sankey_demo_basics.py
@@ -1,4 +1,9 @@
-"""Demonstrate the Sankey class by producing three basic diagrams.
+"""
+================
+The Sankey class
+================
+
+Demonstrate the Sankey class by producing three basic diagrams.
 """
 import numpy as np
 import matplotlib.pyplot as plt