changes for MEP12/sphinx-gallery compliance

matplotlib · NelleV · Jul 15, 2017 · Mar 7, 2017 · Mar 7, 2017 · Mar 10, 2017
commit 82c52f357dae06be17d501d7dc0ef915414d74a1
diff --git a/examples/axisartist/demo_axisline_style.py b/examples/axisartist/demo_axisline_style.py
@@ -1,8 +1,9 @@
 """
-===================
-Demo Axisline Style
-===================
+================
+Axis Line Styles
+================
 
+This example shows some configurations for axis style.
 """
 
 from mpl_toolkits.axisartist.axislines import SubplotZero
@@ -15,10 +16,14 @@
     fig.add_subplot(ax)
 
     for direction in ["xzero", "yzero"]:
+        # adds arrows at the ends of each axis
         ax.axis[direction].set_axisline_style("-|>")
+
+        # adds X and Y-axis from the origin
         ax.axis[direction].set_visible(True)
 
     for direction in ["left", "right", "bottom", "top"]:
+        # hides boarders
         ax.axis[direction].set_visible(False)
 
     x = np.linspace(-0.5, 1., 100)

diff --git a/examples/event_handling/resample.py b/examples/event_handling/resample.py
@@ -1,19 +1,24 @@
 """
-========
-Resample
-========
+===============
+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.
 
 """
+
 import numpy as np
 import matplotlib.pyplot as plt
 
-
 # A class that will downsample the data and recompute when zoomed.
 class DataDisplayDownsampler(object):
     def __init__(self, xdata, ydata):
         self.origYData = ydata
         self.origXData = xdata
-        self.ratio = 5
+        self.ratio = 50
         self.delta = xdata[-1] - xdata[0]
 
     def downsample(self, xstart, xend):

diff --git a/examples/mplot3d/lines3d.py b/examples/mplot3d/lines3d.py
@@ -1,9 +1,9 @@
 '''
-===================
-3D parametric curve
-===================
+================
+Parametric Curve
+================
 
-Demonstrating plotting a parametric curve in 3D.
+This example demonstrates plotting a parametric curve in 3D.
 '''
 
 import matplotlib as mpl

diff --git a/examples/mplot3d/lorenz_attractor.py b/examples/mplot3d/lorenz_attractor.py
@@ -1,10 +1,11 @@
 '''
-====================
-The Lorenz Attractor
-====================
+================
+Lorenz Attractor
+================
+
+This is an example of plotting Edward Lorenz's 1963 "Deterministic
+Nonperiodic Flow" in a 3-dimensional space using mplot3d.
 
-Plot of the Lorenz Attractor based on Edward Lorenz's 1963 "Deterministic
-Nonperiodic Flow" publication.
 http://journals.ametsoc.org/doi/abs/10.1175/1520-0469%281963%29020%3C0130%3ADNF%3E2.0.CO%3B2
 
 Note: Because this is a simple non-linear ODE, it would be more easily

diff --git a/examples/mplot3d/mixed_subplots.py b/examples/mplot3d/mixed_subplots.py
@@ -1,9 +1,8 @@
 """
-==================
-2D and 3D subplots
-==================
-
-Demonstrate the mixing of 2d and 3d subplots.
+============================================
+Demonstrate the mixing of 2d and 3d subplots
+============================================
+This example shows a how to plot a 2D and 3D plot on the same figure.
 """
 
 from mpl_toolkits.mplot3d import Axes3D

diff --git a/examples/mplot3d/offset.py b/examples/mplot3d/offset.py
@@ -1,7 +1,7 @@
 '''
-===================
-Offset text display
-===================
+=========================
+Automatic Text Offsetting
+=========================
 
 This example demonstrates mplot3d's offset text display.
 As one rotates the 3D figure, the offsets should remain oriented the

diff --git a/examples/pylab_examples/bar_stacked.py b/examples/pylab_examples/bar_stacked.py
@@ -1,10 +1,15 @@
 """
-===========
-Bar Stacked
-===========
+=================
+Stacked Bar Graph
+=================
+
+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.
 
-A stacked bar plot with errorbars.
 """
+
+# a stacked bar plot with errorbars
 import numpy as np
 import matplotlib.pyplot as plt
 

diff --git a/examples/pylab_examples/dolphin.py b/examples/pylab_examples/dolphin.py
@@ -1,9 +1,14 @@
 """
 =======
-Dolphin
+Dophins
 =======
 
+
+This example shows how to draw, and manipulate shapes given verticies
+and nodes using the patches, path and transforms classes.
+
 """
+
 import matplotlib.cm as cm
 import matplotlib.pyplot as plt
 from matplotlib.patches import Circle, PathPatch

diff --git a/examples/pylab_examples/fill_between_demo.py b/examples/pylab_examples/fill_between_demo.py
@@ -1,9 +1,11 @@
 """
-=================
-Fill Between Demo
-=================
+==============================
+Filling the area between lines
+==============================
 
+This example shows how to use fill_between() to color between lines based on user-defined logic.
 """
+
 import matplotlib.pyplot as plt
 import numpy as np
 

diff --git a/examples/pylab_examples/geo_demo.py b/examples/pylab_examples/geo_demo.py
@@ -1,9 +1,12 @@
 """
-========
-Geo Demo
-========
+======================
+Geographic Projections
+======================
 
+This shows 4 possible projections using subplot.
+Matplotlib also supports the <a href='http://matplotlib.org/basemap/'>Basemaps Toolkit</a> for geographic projections.
 """
+
 import matplotlib.pyplot as plt
 
 plt.figure()

diff --git a/examples/pylab_examples/log_test.py b/examples/pylab_examples/log_test.py
@@ -1,9 +1,12 @@
 """
 ========
-Log Test
+Log Axis
 ========
 
+This is an example of assigning a log-scale for the x-axis using
+`semilogx`.
 """
+
 import matplotlib.pyplot as plt
 import numpy as np
 

diff --git a/examples/pylab_examples/mri_demo.py b/examples/pylab_examples/mri_demo.py
@@ -1,11 +1,13 @@
 """
-========
-MRI Demo
-========
+===
+MRI
+===
 
-Displays an MRI image.
-"""
 
+This example illustrates how to read an image (of an MRI) into a numpy
+array, and display it in greyscale using `ax.imshow`.
+
+"""
 
 import matplotlib.pyplot as plt
 import matplotlib.cbook as cbook