Skip to content

Commit

Permalink
Figure.contour & Figur.grdcontour: Improve docstring of pen (#3210)
Browse files Browse the repository at this point in the history
  • Loading branch information
yvonnefroehlich committed Apr 29, 2024
1 parent b1f5cc7 commit 48f12cc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
11 changes: 10 additions & 1 deletion pygmt/src/contour.py
Expand Up @@ -102,7 +102,16 @@ def contour(self, data=None, x=None, y=None, z=None, **kwargs):
skip : bool or str
[**p**\|\ **t**].
Skip input points outside region.
{pen}
pen : str or list
[*type*]\ *pen*\ [**+c**\ [**l**\|\ **f**]].
*type*, if present, can be **a** for annotated contours or **c** for regular
contours [Default]. The pen sets the attributes for the particular line.
Default pen for annotated contours is ``"0.75p,black"`` and for regular
contours ``"0.25p,black"``. Normally, all contours are drawn with a fixed
color determined by the pen setting. If **+cl** is appended the colors of the
contour lines are taken from the CPT (see ``levels``). If **+cf** is
appended the colors from the CPT file are applied to the contour annotations.
Select **+c** for both effects.
label : str
Add a legend entry for the contour being plotted. Normally, the
annotated contour is selected for the legend. You can select the
Expand Down
11 changes: 10 additions & 1 deletion pygmt/src/grdcontour.py
Expand Up @@ -88,7 +88,16 @@ def grdcontour(self, grid, **kwargs):
five controlling algorithms. See :gmt-docs:`grdcontour.html#g` for
details.
{verbose}
{pen}
pen : str or list
[*type*]\ *pen*\ [**+c**\ [**l**\|\ **f**]].
*type*, if present, can be **a** for annotated contours or **c** for regular
contours [Default]. The pen sets the attributes for the particular line.
Default pen for annotated contours is ``"0.75p,black"`` and for regular
contours ``"0.25p,black"``. Normally, all contours are drawn with a fixed
color determined by the pen setting. If **+cl** is appended the colors of the
contour lines are taken from the CPT (see ``levels``). If **+cf** is
appended the colors from the CPT file are applied to the contour annotations.
Select **+c** for both effects.
{panel}
{coltypes}
label : str
Expand Down

0 comments on commit 48f12cc

Please sign in to comment.