Documentation and cosmetic changes to mixed_subplots_demo and pathpatch3d_demo

TrishGillett · TrishGillett · commit e552b5e4f7ec · 2016-04-15T10:27:19.000-04:00
diff --git a/examples/mplot3d/mixed_subplots_demo.py b/examples/mplot3d/mixed_subplots_demo.py
@@ -1,6 +1,7 @@
 """
-Demonstrate the mixing of 2d and 3d subplots
+Demonstrate the mixing of 2d and 3d subplots.
 """
+
 from mpl_toolkits.mplot3d import Axes3D
 import matplotlib.pyplot as plt
 import numpy as np
@@ -12,38 +13,42 @@ def f(t):
     return np.multiply(s1, e1)
 
 
-################
+#############################################
+# Set up a figure twice as tall as it is wide
+#############################################
+fig = plt.figure(figsize=plt.figaspect(2.))
+fig.suptitle('A tale of 2 subplots')
+
+
+#############################################
 # First subplot
-################
+#############################################
+ax = fig.add_subplot(2, 1, 1)
+
 t1 = np.arange(0.0, 5.0, 0.1)
 t2 = np.arange(0.0, 5.0, 0.02)
 t3 = np.arange(0.0, 2.0, 0.01)
 
-# Twice as tall as it is wide.
-fig = plt.figure(figsize=plt.figaspect(2.))
-fig.suptitle('A tale of 2 subplots')
-ax = fig.add_subplot(2, 1, 1)
-l = ax.plot(t1, f(t1), 'bo',
-            t2, f(t2), 'k--', markerfacecolor='green')
+ax.plot(t1, f(t1), 'bo',
+        t2, f(t2), 'k--', markerfacecolor='green')
 ax.grid(True)
 ax.set_ylabel('Damped oscillation')
 
 
-#################
+#############################################
 # Second subplot
-#################
+#############################################
 ax = fig.add_subplot(2, 1, 2, projection='3d')
+
 X = np.arange(-5, 5, 0.25)
-xlen = len(X)
 Y = np.arange(-5, 5, 0.25)
-ylen = len(Y)
 X, Y = np.meshgrid(X, Y)
 R = np.sqrt(X**2 + Y**2)
 Z = np.sin(R)
 
 surf = ax.plot_surface(X, Y, Z, rstride=1, cstride=1,
                        linewidth=0, antialiased=False)
-
 ax.set_zlim3d(-1, 1)
 
+
 plt.show()
diff --git a/examples/mplot3d/pathpatch3d_demo.py b/examples/mplot3d/pathpatch3d_demo.py
@@ -1,3 +1,7 @@
+'''
+Demonstrate using pathpatch_2d_to_3d to 'draw' shapes and text on a 3D plot.
+'''
+
 import matplotlib.pyplot as plt
 from matplotlib.patches import Circle, PathPatch
 # register Axes3D class with matplotlib by importing Axes3D
@@ -8,7 +12,15 @@
 
 
 def text3d(ax, xyz, s, zdir="z", size=None, angle=0, usetex=False, **kwargs):
+    '''
+    Plots the string 's' on the axes 'ax', with position 'xyz', size 'size',
+    and rotation angle 'angle'.  'zdir' gives the axis which is to be treated
+    as the third dimension.  usetex is a boolean indicating whether the string
+    should be interpreted as latex or not.  Any additional keyword arguments
+    are passed on to transform_path.
 
+    Note: zdir affects the interpretation of xyz.
+    '''
     x, y, z = xyz
     if zdir == "y":
         xy1, z1 = (x, z), y
@@ -28,18 +40,20 @@ def text3d(ax, xyz, s, zdir="z", size=None, angle=0, usetex=False, **kwargs):
 fig = plt.figure()
 ax = fig.add_subplot(111, projection='3d')
 
+# Draw a circle on the x=0 'wall'
 p = Circle((5, 5), 3)
 ax.add_patch(p)
 art3d.pathpatch_2d_to_3d(p, z=0, zdir="x")
 
-
+# Manually label the axes
 text3d(ax, (4, -2, 0), "X-axis", zdir="z", size=.5, usetex=False,
        ec="none", fc="k")
 text3d(ax, (12, 4, 0), "Y-axis", zdir="z", size=.5, usetex=False,
        angle=.5*3.14159, ec="none", fc="k")
 text3d(ax, (12, 10, 4), "Z-axis", zdir="y", size=.5, usetex=False,
        angle=.5*3.14159, ec="none", fc="k")
 
+# Write a Latex formula on the z=0 'floor'
 text3d(ax, (1, 5, 0),
        r"$\displaystyle G_{\mu\nu} + \Lambda g_{\mu\nu} = "
        r"\frac{8\pi G}{c^4} T_{\mu\nu}  $",
