Merge pull request #1220 from efiring/clarify_figure_show

efiring · efiring · commit 32dc9471c8bf · 2012-09-08T13:36:03.000-07:00
Figure.show: clarify docstring and error message
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -340,12 +340,23 @@ def _setup_canvas(self):
 
     def show(self, warn=True):
         """
-        If using a GUI backend, display the figure window.
+        If using a GUI backend with pyplot, display the figure window.
+
+        If the figure was not created using
+        :func:`~matplotlib.pyplot.figure`, it will lack a
+        :class:`~matplotlib.backend_bases.FigureManagerBase`, and
+        will raise an AttributeError.
 
         For non-GUI backends, this does nothing, in which case
-        a warning will be issued if *warn* is True.
+        a warning will be issued if *warn* is True (default).
         """
-        manager = getattr(self.canvas, 'manager')
+        try:
+            manager = getattr(self.canvas, 'manager')
+        except AttributeError as err:
+            raise AttributeError("%s\n    Figure.show works only "
+                        "for figures managed by pyplot,\n    normally "
+                        "created by pyplot.figure()." % err)
+
         if manager is not None:
             try:
                 manager.show()
