Improve docstrings in offsetbox.py

timhoffm · timhoffm · commit 97360690778e · 2020-01-03T21:43:29.000+01:00
diff --git a/doc/api/offsetbox_api.rst b/doc/api/offsetbox_api.rst
@@ -2,6 +2,9 @@
 ``matplotlib.offsetbox``
 ************************
 
+.. inheritance-diagram:: matplotlib.offsetbox.OffsetBox matplotlib.offsetbox.PackerBase matplotlib.offsetbox.VPacker matplotlib.offsetbox.HPacker matplotlib.offsetbox.PaddedBox matplotlib.offsetbox.DrawingArea matplotlib.offsetbox.TextArea matplotlib.offsetbox.AuxTransformBox matplotlib.offsetbox.AnchoredOffsetbox matplotlib.offsetbox.AnchoredText matplotlib.offsetbox.OffsetImage matplotlib.offsetbox.AnnotationBbox matplotlib.offsetbox.DraggableBase matplotlib.offsetbox.DraggableOffsetBox matplotlib.offsetbox.DraggableAnnotation
+   :parts: 1
+
 .. automodule:: matplotlib.offsetbox
    :members:
    :undoc-members:
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1463,7 +1463,7 @@ def _loop_delay(self, *args):
 
 class ArtistAnimation(TimedAnimation):
     """
-    Animation using a fixed set of `Artist` objects.
+    Animation using a fixed set of `.Artist` objects.
 
     Before creating an instance, all plotting should have taken place
     and the relevant artists saved.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -1217,7 +1217,7 @@ def __init__(self, o):
         r"""
         Initialize the artist inspector with an `Artist` or an iterable of
         `Artist`\s.  If an iterable is used, we assume it is a homogeneous
-        sequence (all `Artists` are of the same type) and it is your
+        sequence (all `Artist`\s are of the same type) and it is your
         responsibility to make sure this is so.
         """
         if not isinstance(o, Artist):
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -424,7 +424,7 @@ def __init__(self, parent, handles, labels,
         self._scatteryoffsets = np.tile(self._scatteryoffsets,
                                         reps)[:self.scatterpoints]
 
-        # _legend_box is an OffsetBox instance that contains all
+        # _legend_box is a VPacker instance that contains all
         # legend items and will be initialized from _init_legend_box()
         # method.
         self._legend_box = None
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
diff --git a/lib/mpl_toolkits/axisartist/axisline_style.py b/lib/mpl_toolkits/axisartist/axisline_style.py
