Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix AnnotationBbox docstring. #15887

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.

Sign up for GitHub

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 1 commit into from
Dec 9, 2019
Merged

Fix AnnotationBbox docstring. #15887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 4 additions & 8 deletions lib/matplotlib/offsetbox.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1421,9 +1421,8 @@ def draw(self, renderer):


class AnnotationBbox(martist.Artist, _AnnotationBase):
"""
Annotation-like class, but with offsetbox instead of Text.
"""
"""`.Annotation`-like class, but with `OffsetBox` instead of `.Text`."""

zorder = 3

def __str__(self):
Expand All @@ -1444,12 +1443,9 @@ def __init__(self, offsetbox, xy,
"""
*offsetbox* : OffsetBox instance

*xycoords* : same as Annotation but can be a tuple of two
strings which are interpreted as x and y coordinates.
*xycoords* : same as Annotation

*boxcoords* : similar to textcoords as Annotation but can be a
tuple of two strings which are interpreted as x and y
coordinates.
*boxcoords* : similar to Annotation's textcoords

*box_alignment* : a tuple of two floats for a vertical and
horizontal alignment of the offset box w.r.t. the *boxcoords*.
Expand Down