Add documentation for axis_grid1.inset_locator.InsetPosition

matplotlib · tacaswell · Dec 16, 2015 · Jul 30, 2015 · Jul 30, 2015 · Jul 31, 2015
commit 748fff836587a137b99d237b48cbbf26cb18c962
diff --git a/lib/mpl_toolkits/axes_grid1/inset_locator.py b/lib/mpl_toolkits/axes_grid1/inset_locator.py
@@ -14,11 +14,41 @@
 from matplotlib import docstring
 
 
+@docstring.dedent_interpd
 class InsetPosition(object):
+    """
+    An object for positioning an inset axes.
+
+    This is created by specifying the normalized coordinates in the axes,
+    instead of the figure.
+
+    Parameters
+    ----------
+    parent : `matplotlib.axes.Axes`
+        Axes to use for normalizing coordinates.
+
+    lbwh : iterable of four floats
+        The left edge, bottom edge, width, and height of the inset axes, in
+        units of the normalized coordinate of the *parent* axes.
+
+    See Also
+    --------
+    :meth:`matplotlib.axes.Axes.set_axes_locator`
+
+    Examples
+    --------
+    The following bounds the inset axes to a box with 20%% of the parent
+    axes's height and 40%% of the width. The size of the axes specified
+    ([0, 0, 1, 1]) ensures that the axes completely fills the bounding box:
+
+    >>> parent_axes = plt.gca()
+    >>> ax_ins = plt.axes([0, 0, 1, 1])
+    >>> ip = InsetPosition(ax, [0.5, 0.1, 0.4, 0.2])
+    >>> ax_ins.set_axes_locator(ip)
+    """
     def __init__(self, parent, lbwh):
         self.parent = parent
-        self.lbwh = lbwh  # position of the inset axes in
-                          # the normalized coordinate of the parent axes
+        self.lbwh = lbwh
 
     def __call__(self, ax, renderer):
         bbox_parent = self.parent.get_position(original=False)