DOC : add caveat to mpl_toolkits ImageGrid

tacaswell · tacaswell · commit 8385e05f65be · 2015-01-19T18:40:53.000-05:00
The `axes_class` kwarg must be a sub-class of the Axes
subclass which has the axis artist replaced as done in
`mpl_toolkits.axes_grid1.mpl_axes.Axes`.
diff --git a/lib/mpl_toolkits/axes_grid1/axes_grid.py b/lib/mpl_toolkits/axes_grid1/axes_grid.py
@@ -26,6 +26,7 @@ def _extend_axes_pad(value):
         ret = (value, value)
     return ret
 
+
 def _tick_only(ax, bottom_on, left_on):
     bottom_off = not bottom_on
     left_off = not left_on
@@ -516,7 +517,8 @@ def __init__(self, fig,
           cbar_size         "5%"
           cbar_set_cax      True      [ True | False ]
           axes_class        None      a type object which must be a subclass
-                                      of :class:`~matplotlib.axes.Axes`
+                                      of axes_grid's subclass of
+                                      :class:`~matplotlib.axes.Axes`
           ================  ========  =========================================
 
         *cbar_set_cax* : if True, each axes in the grid has a cax
