Skip to content

Improve docstrings in offsetbox.py #16085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/api/offsetbox_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
``matplotlib.offsetbox``
************************

.. inheritance-diagram:: matplotlib.offsetbox
:parts: 1

.. automodule:: matplotlib.offsetbox
:members:
:undoc-members:
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/animation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/artist.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/legend.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading