Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 884affe

Browse filesBrowse files
committed
Fix AnnotationBbox docstring.
Yes, it's still not numpydoc because there's a few parameters that I don't want to figure out (e.g. what does boxcoords really do). The point is solely that Annotation's xycoords/textcoords also support the (xvalue, yvalue) tuple form and so it's not specific to AnnotationBbox.
1 parent cf6c569 commit 884affe
Copy full SHA for 884affe

File tree

Expand file treeCollapse file tree

1 file changed

+4
-8
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+4
-8
lines changed

‎lib/matplotlib/offsetbox.py

Copy file name to clipboardExpand all lines: lib/matplotlib/offsetbox.py
+4-8Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,9 +1421,8 @@ def draw(self, renderer):
14211421

14221422

14231423
class AnnotationBbox(martist.Artist, _AnnotationBase):
1424-
"""
1425-
Annotation-like class, but with offsetbox instead of Text.
1426-
"""
1424+
"""`.Annotation`-like class, but with `OffsetBox` instead of `.Text`."""
1425+
14271426
zorder = 3
14281427

14291428
def __str__(self):
@@ -1444,12 +1443,9 @@ def __init__(self, offsetbox, xy,
14441443
"""
14451444
*offsetbox* : OffsetBox instance
14461445
1447-
*xycoords* : same as Annotation but can be a tuple of two
1448-
strings which are interpreted as x and y coordinates.
1446+
*xycoords* : same as Annotation
14491447
1450-
*boxcoords* : similar to textcoords as Annotation but can be a
1451-
tuple of two strings which are interpreted as x and y
1452-
coordinates.
1448+
*boxcoords* : similar to Annotation's textcoords
14531449
14541450
*box_alignment* : a tuple of two floats for a vertical and
14551451
horizontal alignment of the offset box w.r.t. the *boxcoords*.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.