Edited documentation, modified square plot test

basharovV · basharovV · commit ee5ccc7df9b3 · 2015-04-14T18:52:07.000-04:00
diff --git a/doc/users/whats_new/square_plot_feature.rst b/doc/users/whats_new/square_plot_feature.rst
@@ -3,11 +3,9 @@ Square Plot
 
 Square plot:
 
-Added implementation of square plot feature that sets the axes of a plot
-to have the same maximum difference between them, and set the scale to be
-the same for both axes, creating a square plot.
+Implemented square plots feature as a new parameter in the axis function. When argument 'square' is specified, equal scaling is set, and the limits are set such that xmax-xmin == ymax-ymin.  
 
-Example shown by:
+Example:
 
 ``ax.axis('square')``
 
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1287,13 +1287,44 @@ def apply_aspect(self, position=None):
 
     def axis(self, *v, **kwargs):
         """
-        Convenience method for manipulating the x and y view limits
-        and the aspect ratio of the plot. For details, see
-        :func:`~matplotlib.pyplot.axis`.
+        Call signature::
+
+          axis(*v, **kwargs)
+
+        Examples: 
+
+          axis('equal')
+          axis([0, 10, 2, 8])
+          axis(xmin=1, xmax=2)
+
+        Convenience method for manipulating axis properties such as 
+        the x and y view limits and the aspect ratio of the plot. 
+
+        ACCEPTS: [length 4 sequence of floats
+                  | 'on' | 'off' | 'equal' | 'tight' | 'scaled'
+                  | 'normal' | 'auto' | 'image'| 'square' ]
+
+        Keyword arguments:
+
+          *xmin*:scalar
+          Minimum limit on the x-axis
+
+          *xmax*:scalar
+          Maximum limit on the x-axis
+
+          *ymin*:scalar
+          Minimum limit on the y-axis
+
+          *ymax*:scalar
+          Maximum limit on the y-axis
 
         *kwargs* are passed on to :meth:`set_xlim` and
         :meth:`set_ylim`
+
+        For details, see
+        :func:`~matplotlib.pyplot.axis`.
         """
+
         if len(v) == 0 and len(kwargs) == 0:
             xmin, xmax = self.get_xlim()
             ymin, ymax = self.get_ylim()
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1410,9 +1410,9 @@ def axis(*v, **kwargs):
 
       >>> axis('square')
 
-    changes the limits of the (*xmax*-*xmin*) and (*ymax*-*ymin*) of
+    changes the limit ranges (*xmax*-*xmin*) and (*ymax*-*ymin*) of
     the *x* and *y* axes to be the same, and have the same scaling,
-    resulting in a square plot
+    resulting in a square plot.
 
     .. seealso::
 
diff --git a/lib/matplotlib/tests/baseline_images/test_axes/square_plot.png b/lib/matplotlib/tests/baseline_images/test_axes/square_plot.png
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -3635,13 +3635,16 @@ def test_bar_negative_width():
         assert_equal(b._width, 1)
         assert_equal(b._height, indx + 1)
 
-@image_comparison(baseline_images=['square_plot'], extensions=['png'])
+@cleanup
 def test_square_plot():
     x = np.arange(4)
     y = np.array([1., 3., 5., 7.])
     fig, ax = plt.subplots()
     ax.plot(x, y, 'mo')
     ax.axis('square')
+    xlim, ylim = ax.get_xlim(), ax.get_ylim()
+    assert_true(np.diff(xlim) == np.diff(ylim))
+    assert_true(ax.get_aspect() == 'equal')
 
 if __name__ == '__main__':
     import nose
