DOC : minor tweaks to set/get_size_inches

tacaswell · tacaswell · commit d79dbc73501c · 2014-02-25T23:47:38.000-05:00
- better numpydoc style
 - added inch &lt;-&gt; cm conversion factor
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -623,7 +623,7 @@ def set_size_inches(self, *args, **kwargs):
         """
         set_size_inches(w,h, forward=False)
 
-        Set the figure size in inches
+        Set the figure size in inches (1in == 2.54cm)
 
         Usage::
 
@@ -636,7 +636,10 @@ def set_size_inches(self, *args, **kwargs):
 
         ACCEPTS: a w,h tuple with w,h in inches
 
-        .. seealso:: :func:`~matplotlib.Figure.get_size_inches`
+        See Also
+        --------
+
+        :func:`~matplotlib.Figure.get_size_inches`
         """
 
         forward = kwargs.get('forward', False)
@@ -658,14 +661,18 @@ def set_size_inches(self, *args, **kwargs):
 
     def get_size_inches(self):
         """
-        Returns the current size of the figure in inches as an numpy array.
+        Returns the current size of the figure in inches (1in == 2.54cm)
+        as an numpy array.
 
         Returns
         -------
         size : ndarray
            The size of the figure in inches
 
-        .. seealso:: :func:`~matplotlib.Figure.set_size_inches`
+        Also See
+        --------
+
+        :func:`~matplotlib.Figure.set_size_inches`
         """
         return np.array(self.bbox_inches.p1)
 
