Skip to content

DOC: Improve the docstrings of the 'panel' parameter #3930

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
17 changes: 9 additions & 8 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,14 +262,15 @@
""",
"panel": r"""
panel : bool, int, or list
[*row,col*\|\ *index*].
Select a specific subplot panel. Only allowed when in subplot
mode. Use ``panel=True`` to advance to the next panel in the
selected order. Instead of *row,col* you may also give a scalar
value *index* which depends on the order you set via ``autolabel``
when the subplot was defined. **Note**: *row*, *col*, and *index*
all start at 0.
""",
Select a specific subplot panel. Only allowed when used in
:meth:`Figure.subplot`.

- ``True`` to advance to the next panel in the selected order.
- *index* to specify the index of the desired panel.
- (*row*, *col*) to specify the row and column of the desired panel.

The panel order is determined by the :meth:`Figure.subplot` method. *row*,
*col* and *index* all start at 0.""",
"pen": r"""
pen : str
Set pen attributes for lines or the outline of symbols.""",
Expand Down