Skip to content

Commit ca4503a

Browse files
DOC: Improve the docstrings of the 'panel' parameter (#3930)
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
1 parent d29303b commit ca4503a

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

pygmt/helpers/decorators.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -262,14 +262,15 @@
262262
""",
263263
"panel": r"""
264264
panel : bool, int, or list
265-
[*row,col*\|\ *index*].
266-
Select a specific subplot panel. Only allowed when in subplot
267-
mode. Use ``panel=True`` to advance to the next panel in the
268-
selected order. Instead of *row,col* you may also give a scalar
269-
value *index* which depends on the order you set via ``autolabel``
270-
when the subplot was defined. **Note**: *row*, *col*, and *index*
271-
all start at 0.
272-
""",
265+
Select a specific subplot panel. Only allowed when used in
266+
:meth:`Figure.subplot` mode.
267+
268+
- ``True`` to advance to the next panel in the selected order.
269+
- *index* to specify the index of the desired panel.
270+
- (*row*, *col*) to specify the row and column of the desired panel.
271+
272+
The panel order is determined by the :meth:`Figure.subplot` method. *row*,
273+
*col* and *index* all start at 0.""",
273274
"pen": r"""
274275
pen : str
275276
Set pen attributes for lines or the outline of symbols.""",

0 commit comments

Comments
 (0)