Merge pull request #2836 from tacaswell/set_size_doc

NelleV · NelleV · commit 99d5012a6f70 · 2014-04-08T14:48:35.000+02:00
DOC/ENH : get/set_size_inches
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::
 
@@ -635,6 +635,11 @@ def set_size_inches(self, *args, **kwargs):
         from the shell
 
         ACCEPTS: a w,h tuple with w,h in inches
+
+        See Also
+        --------
+
+        :func:`~matplotlib.Figure.get_size_inches`
         """
 
         forward = kwargs.get('forward', False)
@@ -655,7 +660,21 @@ def set_size_inches(self, *args, **kwargs):
                 manager.resize(int(canvasw), int(canvash))
 
     def get_size_inches(self):
-        return self.bbox_inches.p1
+        """
+        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
+
+        See Also
+        --------
+
+        :func:`~matplotlib.Figure.set_size_inches`
+        """
+        return np.array(self.bbox_inches.p1)
 
     def get_edgecolor(self):
         'Get the edge color of the Figure rectangle'
