mplot3d document cleanup and terminology standardizing

WeatherGod · WeatherGod · commit c2705d0cf49e · 2011-07-08T20:06:57.000-05:00
diff --git a/doc/mpl_toolkits/mplot3d/api.rst b/doc/mpl_toolkits/mplot3d/api.rst
@@ -22,7 +22,7 @@ mplot3d API
 
 .. note::
    Historically, axis3d has suffered from having hard-coded constants
-   controlling the look and feel of the 3d plot. This precluded user
+   controlling the look and feel of the 3D plot. This precluded user
    level adjustments such as label spacing, font colors and panel colors.
    For version 1.1.0, these constants have been consolidated into a single
    private member dictionary, `self._axinfo`, for the axis object. This is
diff --git a/doc/mpl_toolkits/mplot3d/faq.rst b/doc/mpl_toolkits/mplot3d/faq.rst
@@ -6,7 +6,8 @@ mplot3d FAQ
 
 How is mplot3d different from MayaVi?
 =====================================
-`MayaVi2 <http://code.enthought.com/projects/mayavi/documentation.php>`_ is a very powerful and featureful 3D graphing library. For advanced
+`MayaVi2 <http://code.enthought.com/projects/mayavi/documentation.php>`_
+is a very powerful and featureful 3D graphing library. For advanced
 3D scenes and excellent rendering capabilities, it is highly recomended to
 use MayaVi2.
 
@@ -19,7 +20,7 @@ plots.
 My 3D plot doesn't look right at certain viewing angles
 =======================================================
 This is probably the most commonly reported issue with mplot3d. The problem
-is that -- from some viewing angles -- some 3D objects would appear in front
+is that -- from some viewing angles -- a 3D object would appear in front
 of another object, even though it is physically behind it. This can result in
 plots that do not look "physically correct."
 
@@ -28,7 +29,7 @@ artifact, it is currently an intractable problem, and can not be fully solved
 until matplotlib supports 3D graphics rendering at its core.
 
 The problem occurs due to the reduction of 3D data down to 2D + z-order
-scalar. A single value represents the 3rd dimention for all parts of 3D
+scalar. A single value represents the 3rd dimension for all parts of 3D
 objects in a collection. Therefore, when the bounding boxes of two collections
 intersect, it becomes possible for this artifact to occur. Furthermore, the
 intersection of two 3D objects (such as polygons or patches) can not be
diff --git a/doc/mpl_toolkits/mplot3d/index.rst b/doc/mpl_toolkits/mplot3d/index.rst
@@ -7,15 +7,15 @@ mplot3d
 
 Matplotlib mplot3d toolkit
 ==========================
-The mplot3d toolkit adds simple 3d plotting capabilities to matplotlib by
-supplying an axes object that can create a 2d projection of a 3d scene.
-The resulting graph will have the same look and feel as regular 2d plots.
+The mplot3d toolkit adds simple 3D plotting capabilities to matplotlib by
+supplying an axes object that can create a 2D projection of a 3D scene.
+The resulting graph will have the same look and feel as regular 2D plots.
 
 The interactive backends also provide the ability to rotate and zoom
-the 3d scene. One can rotate the 3d scene by simply clicking-and-dragging
+the 3D scene. One can rotate the 3D scene by simply clicking-and-dragging
 the scene. Zooming is done by right-clicking the scene and dragging the
 mouse up and down. Note that one does not use the zoom button like one
-would use for regular 2d plots.
+would use for regular 2D plots.
 
 .. toctree::
     :maxdepth: 2
diff --git a/doc/mpl_toolkits/mplot3d/tutorial.rst b/doc/mpl_toolkits/mplot3d/tutorial.rst
@@ -22,10 +22,10 @@ add a new axes to it of type :class:`~mpl_toolkits.mplot3d.Axes3D`::
   ax = fig.add_subplot(111, projection='3d')
 
 .. versionadded:: 1.0.0
-   This approach is the preferred method of creating a 3d axes.
+   This approach is the preferred method of creating a 3D axes.
 
 .. note::
-   Prior to version 1.0.0, the method of creating a 3d axes was
+   Prior to version 1.0.0, the method of creating a 3D axes was
    different. For those using older versions of matplotlib, change
    ``ax = fig.add_subplot(111, projection='3d')``
    to ``ax = Axes3D(fig)``.
@@ -121,12 +121,12 @@ Text
 
 Subplotting
 ====================
-Having multiple 3d plots in a single figure is the same
-as it is for 2d plots. Also, you can have both 2d and 3d plots
+Having multiple 3D plots in a single figure is the same
+as it is for 2D plots. Also, you can have both 2D and 3D plots
 in the same figure.
 
 .. versionadded:: 1.0.0
-   Subplotting 3d plots was added in v1.0.0.  Earlier version can not
+   Subplotting 3D plots was added in v1.0.0.  Earlier version can not
    do this.
 
 .. plot:: mpl_examples/mplot3d/subplot3d_demo.py
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -123,7 +123,7 @@ def set_top_view(self):
         Axes.set_ylim(self, -ydwl, ydw, auto=None)
 
     def _init_axis(self):
-        '''Init 3d axes; overrides creation of regular X/Y axes'''
+        '''Init 3D axes; overrides creation of regular X/Y axes'''
         self.w_xaxis = axis3d.XAxis('x', self.xy_viewLim.intervalx,
                             self.xy_dataLim.intervalx, self)
         self.xaxis = self.w_xaxis
@@ -401,7 +401,7 @@ def autoscale_view(self, tight=None, scalex=True, scaley=True,
         """
         Autoscale the view limits using the data limits.
         See :meth:`matplotlib.axes.Axes.autoscale_view` for documentation.
-        Note that this function applies to the 3d axes, and as such
+        Note that this function applies to the 3D axes, and as such
         adds the *scalez* to the function arguments.
 
         .. versionchanged :: 1.1.0
@@ -463,7 +463,7 @@ def autoscale_view(self, tight=None, scalex=True, scaley=True,
             self.set_zlim3d(self.zz_dataLim.intervalx)
 
     def get_w_lims(self):
-        '''Get 3d world limits.'''
+        '''Get 3D world limits.'''
         minx, maxx = self.get_xlim3d()
         miny, maxy = self.get_ylim3d()
         minz, maxz = self.get_zlim3d()
@@ -697,7 +697,7 @@ def get_zticklines(self) :
 
     def clabel(self, *args, **kwargs):
         """
-        This function is currently not implemented for 3d axes.
+        This function is currently not implemented for 3D axes.
         Returns *None*.
         """
         return None
@@ -983,15 +983,15 @@ def get_zlabel(self) :
 
     def get_frame_on(self):
         """
-        Get whether the 3d axes panels are drawn
+        Get whether the 3D axes panels are drawn
 
         .. versionadded :: 1.1.0
         """
         return self._frameon
 
     def set_frame_on(self, b):
         """
-        Set whether the 3d axes panels are drawn
+        Set whether the 3D axes panels are drawn
 
         ACCEPTS: [ *True* | *False* ]
 
@@ -1257,7 +1257,7 @@ def plot(self, xs, ys, *args, **kwargs):
         *zs*        z value(s), either one for all points or one for
                     each point.
         *zdir*      Which direction to use as z ('x', 'y' or 'z')
-                    when plotting a 2d set.
+                    when plotting a 2D set.
         ==========  ================================================
 
         Other arguments are passed on to
@@ -1723,7 +1723,7 @@ def tricontourf(self, X, Y, Z, offset=None, zdir='z', *args, **kwargs):
 
     def add_collection3d(self, col, zs=0, zdir='z'):
         '''
-        Add a 3d collection object to the plot.
+        Add a 3D collection object to the plot.
 
         2D collection types are converted to a 3D version by
         modifying the object and adding z coordinate information.
@@ -1760,7 +1760,7 @@ def scatter(self, xs, ys, zs=0, zdir='z', s=20, c='b', *args, **kwargs):
                     *ys* or a single value to place all points in
                     the same plane. Default is 0.
         *zdir*      Which direction to use as z ('x', 'y' or 'z')
-                    when plotting a 2d set.
+                    when plotting a 2D set.
         *s*         size in points^2.  It is a scalar or an array of the same
                     length as *x* and *y*.
 
@@ -1828,7 +1828,7 @@ def bar(self, left, height, zs=0, zdir='z', *args, **kwargs):
         *zs*        Z coordinate of bars, if one value is specified
                     they will all be placed at the same z.
         *zdir*      Which direction to use as z ('x', 'y' or 'z')
-                    when plotting a 2d set.
+                    when plotting a 2D set.
         ==========  ================================================
 
         Keyword arguments are passed onto :func:`~matplotlib.axes.Axes.bar`.
