Comments and cosmetic changes to mplot3d examples: custom_shaded_3d_surface, lines3d_demo, offset_demo

TrishGillett · TrishGillett · commit 51642d76ea77 · 2016-04-14T14:17:50.000-04:00
diff --git a/examples/mplot3d/custom_shaded_3d_surface.py b/examples/mplot3d/custom_shaded_3d_surface.py
@@ -1,13 +1,15 @@
 """
 Demonstrates using custom hillshading in a 3D surface plot.
 """
+
 from mpl_toolkits.mplot3d import Axes3D
 from matplotlib import cbook
 from matplotlib import cm
 from matplotlib.colors import LightSource
 import matplotlib.pyplot as plt
 import numpy as np
 
+# Load and format data
 filename = cbook.get_sample_data('jacksboro_fault_dem.npz', asfileobj=False)
 with np.load(filename) as dem:
     z = dem['elevation']
@@ -19,6 +21,7 @@
 region = np.s_[5:50, 5:50]
 x, y, z = x[region], y[region], z[region]
 
+# Set up plot
 fig, ax = plt.subplots(subplot_kw=dict(projection='3d'))
 
 ls = LightSource(270, 45)
diff --git a/examples/mplot3d/lines3d_demo.py b/examples/mplot3d/lines3d_demo.py
@@ -1,3 +1,7 @@
+'''
+Demonstrating plotting a parametric curve in 3D.
+'''
+
 import matplotlib as mpl
 from mpl_toolkits.mplot3d import Axes3D
 import numpy as np
@@ -7,11 +11,14 @@
 
 fig = plt.figure()
 ax = fig.gca(projection='3d')
+
+# Prepare arrays x, y, z
 theta = np.linspace(-4 * np.pi, 4 * np.pi, 100)
 z = np.linspace(-2, 2, 100)
 r = z**2 + 1
 x = r * np.sin(theta)
 y = r * np.cos(theta)
+
 ax.plot(x, y, z, label='parametric curve')
 ax.legend()
 
diff --git a/examples/mplot3d/offset_demo.py b/examples/mplot3d/offset_demo.py
@@ -1,25 +1,30 @@
+'''
+This example demonstrates mplot3d's offset text display.
+As one rotates the 3D figure, the offsets should remain oriented the
+same way as the axis label, and should also be located "away"
+from the center of the plot.
+
+This demo triggers the display of the offset text for the x and
+y axis by adding 1e5 to X and Y. Anything less would not
+automatically trigger it.
+'''
+
 from mpl_toolkits.mplot3d import Axes3D
 import matplotlib.pyplot as plt
 import numpy as np
 
-# This example demonstrates mplot3d's offset text display.
-# As one rotates the 3D figure, the offsets should remain oriented
-# same way as the axis label, and should also be located "away"
-# from the center of the plot.
-#
-# This demo triggers the display of the offset text for the x and
-# y axis by adding 1e5 to X and Y. Anything less would not
-# automatically trigger it.
 
 fig = plt.figure()
 ax = fig.gca(projection='3d')
+
 X, Y = np.mgrid[0:6*np.pi:0.25, 0:4*np.pi:0.25]
 Z = np.sqrt(np.abs(np.cos(X) + np.cos(Y)))
 
-surf = ax.plot_surface(X + 1e5, Y + 1e5, Z, cmap='autumn', cstride=2, rstride=2)
-ax.set_xlabel("X-Label")
-ax.set_ylabel("Y-Label")
-ax.set_zlabel("Z-Label")
+ax.plot_surface(X + 1e5, Y + 1e5, Z, cmap='autumn', cstride=2, rstride=2)
+
+ax.set_xlabel("X label")
+ax.set_ylabel("Y label")
+ax.set_zlabel("Z label")
 ax.set_zlim(0, 2)
 
 plt.show()
