doc

OceanWolf · OceanWolf · commit e300707a70b7 · 2016-08-04T01:37:31.000+02:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3480,6 +3480,15 @@ def remove_toolitem(self, name):
 
 
 class FlowBase(object):
+    """
+    Base mixin class for all GUI elements that can flow, aka laid out in
+    different directions.
+
+    The MPL window class deals with the manipulation of this mixin, so users
+    don't actually need to interact with this class.
+
+    Classes the implement this class must override the _update_flow method.
+    """
     flow_types = ['horizontal', 'vertical']
 
     def __init__(self, flow='horizontal', flow_locked=False, **kwargs):
@@ -3489,6 +3498,9 @@ def __init__(self, flow='horizontal', flow_locked=False, **kwargs):
 
     @property
     def flow(self):
+        """
+        The direction of flow, one of the strings in `flow_type`.
+        """
         return FlowBase.flow_types[self._flow]
 
     @flow.setter
@@ -3504,6 +3516,11 @@ def flow(self, flow):
         self._update_flow()
 
     def _update_flow(self):
+        """
+        Classes that extend FlowBase must override this method.
+        You can use the internal property self._flow whereby
+        flow_types[self._flow] gives the current flow.
+        """
         raise NotImplementedError
 
 
diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -64,7 +64,7 @@ class FigureManager(cbook.EventEmitter):
     figure : `matplotlib.figure.Figure`
         The figure that holds the canvas
 
-    toolbar : `matplotlib.backend_bases.NavigationToolbar2`
+    toolbar : `matplotlib.backend_bases.ToolbarBase`
         The toolbar used for interacting with the figure.
 
     window : `matplotlib.backend_bases.WindowBase`
