DOC added documentation on frontpage example

NelleV · NelleV · commit 303938f8f710 · 2016-12-01T21:25:39.000-08:00
diff --git a/examples/frontpage/plot_3D.py b/examples/frontpage/plot_3D.py
@@ -1,5 +1,10 @@
 """
-Demonstrates using custom hillshading in a 3D surface plot.
+====================
+Frontpage 3D example
+====================
+
+This example reproduces the frontpage 3D example.
+
 """
 from mpl_toolkits.mplot3d import Axes3D
 from matplotlib import cbook
@@ -19,7 +24,7 @@
 region = np.s_[5:50, 5:50]
 x, y, z = x[region], y[region], z[region]
 
-fig, ax = plt.subplots(subplot_kw=dict(projection='3d'))
+fig, ax = plt.subplots(subplot_kw=dict(projection='3d'), figsize=(2.25, 2))
 
 ls = LightSource(270, 45)
 # To use a custom hillshading mode, override the built-in shading and pass
@@ -30,4 +35,4 @@
 ax.set_xticks([])
 ax.set_yticks([])
 ax.set_zticks([])
-fig.savefig("surface3D_frontpage.png")
+fig.savefig("surface3d_frontpage.png")
diff --git a/examples/frontpage/plot_contour.py b/examples/frontpage/plot_contour.py
@@ -1,3 +1,11 @@
+"""
+=========================
+Frontpage contour example
+=========================
+
+This example reproduces the frontpage contour example.
+"""
+
 import matplotlib.pyplot as plt
 import numpy as np
 from matplotlib import mlab, cm
@@ -18,7 +26,7 @@
 levels = np.linspace(-2.0, 1.601, 40)
 norm = cm.colors.Normalize(vmax=abs(Z).max(), vmin=-abs(Z).max())
 
-fig, ax = plt.subplots()
+fig, ax = plt.subplots(figsize=(2.25, 2))
 cset1 = ax.contourf(
     X, Y, Z, levels,
     norm=norm)
diff --git a/examples/frontpage/plot_histogram.py b/examples/frontpage/plot_histogram.py
@@ -1,11 +1,19 @@
+"""
+===========================
+Frontpage histogram example
+===========================
+
+This example reproduces the frontpage histogram example.
+"""
+
 import matplotlib.pyplot as plt
 import numpy as np
 
 
 random_state = np.random.RandomState(19680801)
 X = random_state.randn(10000)
 
-fig, ax = plt.subplots()
+fig, ax = plt.subplots(figsize=(2.25, 2))
 ax.hist(X, bins=25, normed=True)
 x = np.linspace(-5, 5, 1000)
 ax.plot(x, 1 / np.sqrt(2*np.pi) * np.exp(-(x**2)/2), linewidth=4)
diff --git a/examples/frontpage/plot_membrane.py b/examples/frontpage/plot_membrane.py
@@ -1,3 +1,12 @@
+"""
+======================
+Frontpage plot example
+======================
+
+
+This example reproduces the frontpage simple plot example.
+"""
+
 import matplotlib.pyplot as plt
 import matplotlib.cbook as cbook
 import numpy as np
@@ -7,7 +16,7 @@
 x = np.fromstring(open(datafile, 'rb').read(), np.float32)
 # 0.0005 is the sample interval
 
-fig, ax = plt.subplots()
+fig, ax = plt.subplots(figsize=(2.25, 2))
 ax.plot(x, linewidth=4)
 ax.set_xlim(5000, 6000)
 ax.set_ylim(-0.6, 0.1)
