From 8a878ff428e513246d89d98450879b82700f9e5f Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Thu, 17 Jun 2021 13:39:41 +0200 Subject: [PATCH] Shorten the AnchoredOffsetbox docstring. The locations are listed in the same format as in inset_locator. --- lib/matplotlib/offsetbox.py | 24 ++++-------------------- 1 file changed, 4 insertions(+), 20 deletions(-) diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py index 646186891648..f0a25ca6cb74 100644 --- a/lib/matplotlib/offsetbox.py +++ b/lib/matplotlib/offsetbox.py @@ -970,43 +970,27 @@ def __init__(self, loc, Parameters ---------- loc : str - The box location. Supported values: - - - 'upper right' - - 'upper left' - - 'lower left' - - 'lower right' - - 'center left' - - 'center right' - - 'lower center' - - 'upper center' - - 'center' - + The box location. Valid locations are + 'upper left', 'upper center', 'upper right', + 'center left', 'center', 'center right', + 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter *loc* of `.Legend` for details. - pad : float, default: 0.4 Padding around the child as fraction of the fontsize. - borderpad : float, default: 0.5 Padding between the offsetbox frame and the *bbox_to_anchor*. - child : `.OffsetBox` The box that will be anchored. - prop : `.FontProperties` This is only used as a reference for paddings. If not given, :rc:`legend.fontsize` is used. - frameon : bool Whether to draw a frame around the box. - bbox_to_anchor : `.BboxBase`, 2-tuple, or 4-tuple of floats Box that is used to position the legend in conjunction with *loc*. - bbox_transform : None or :class:`matplotlib.transforms.Transform` The transform for the bounding box (*bbox_to_anchor*). - **kwargs All other parameters are passed on to `.OffsetBox`.