8000 DOC: Add numpydoc headings for offsetbox. · matplotlib/matplotlib@8f79d6c · GitHub
[go: up one dir, main page]

Skip to content

Commit 8f79d6c

Browse files
committed
DOC: Add numpydoc headings for offsetbox.
1 parent fd99b3d commit 8f79d6c

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

lib/matplotlib/offsetbox.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,15 @@ def _get_aligned_offsets(hd_list, height, align="baseline"):
142142
*mode*. xdescent is analogous to the usual descent, but along the
143143
x-direction. xdescent values are currently ignored.
144144
145-
*hd_list* : list of (width, xdescent) of boxes to be aligned.
146-
*sep* : spacing between boxes
147-
*height* : Intended total length. None if not used.
148-
*align* : align mode. 'baseline', 'top', 'bottom', or 'center'.
145+
Parameters
146+
----------
147+
hd_list
148+
List of (height, xdescent) of boxes to be aligned.
149+
height : float or None
150+
Intended total length. If None, the maximum of the heights in *hd_list*
151+
is used.
152+
align : {'baseline', 'left', 'top', 'right', 'bottom', 'center'}
153+
Align mode.
149154
"""
150155

151156
if height is None:

0 commit comments

Comments
 (0)
0