Skip to content

Commit

Permalink
Fix default for pen parameter in API documentation (#2134)
Browse files Browse the repository at this point in the history
  • Loading branch information
yvonnefroehlich authored Sep 25, 2022
1 parent 9d404f7 commit 001822f
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 10 deletions.
9 changes: 4 additions & 5 deletions pygmt/src/coast.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,7 @@ def coast(self, **kwargs):
rivers : int or str or list
*river*\ [/*pen*].
Draw rivers. Specify the type of rivers and [optionally] append
pen attributes [Default pen is width = default, color = black,
style = solid].
pen attributes [Default is ``"0.25p,black,solid"``].
Choose from the list of river types below; pass a list to
``rivers`` to use multiple arguments.
Expand Down Expand Up @@ -133,8 +132,8 @@ def coast(self, **kwargs):
borders : int or str or list
*border*\ [/*pen*].
Draw political boundaries. Specify the type of boundary and
[optionally] append pen attributes [Default pen is width = default,
color = black, style = solid].
[optionally] append pen attributes
[Default is ``"0.25p,black,solid"``].
Choose from the list of boundaries below. Pass a list to
``borders`` to use multiple arguments.
Expand All @@ -152,7 +151,7 @@ def coast(self, **kwargs):
shorelines : int or str or list
[*level*\ /]\ *pen*.
Draw shorelines [Default is no shorelines]. Append pen attributes
[Default is width = default, color = black, style = solid] which
[Default is ``"0.25p,black,solid"``] which
apply to all four levels. To set the pen for a single level,
pass a string with *level*\ /*pen*\ , where level is
1-4 and represent coastline, lakeshore, island-in-lake shore, and
Expand Down
3 changes: 1 addition & 2 deletions pygmt/src/solar.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ def solar(self, terminator="d", terminator_datetime=None, **kwargs):
fill : str
Color or pattern for filling of terminators.
pen : str
Set pen attributes for lines. The default pen
is ``"0.25p,black,solid"``.
Set pen attributes for lines [Default is ``"0.25p,black,solid"``].
{timestamp}
{verbose}
{xyshift}
Expand Down
3 changes: 1 addition & 2 deletions pygmt/src/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,7 @@ def text_(
for this line.
pen : str
Sets the pen used to draw a rectangle around the text string
(see ``clearance``) [Default is width = default, color = black,
style = solid].
(see ``clearance``) [Default is ``"0.25p,black,solid"``].
no_clip : bool
Do NOT clip text at map boundaries [Default is will clip].
{timestamp}
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/velo.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def velo(self, data=None, **kwargs):
pen : str
[*pen*][**+c**\ [**f**\|\ **l**]].
Set pen attributes for velocity arrows, ellipse circumference and fault
plane edges. [Defaults: width = default, color = black, style = solid].
plane edges [Default is ``"0.25p,black,solid"``].
If the modifier **+cl** is appended then the color of the pen is
updated from the CPT (see ``cmap``). If instead modifier **+cf** is
appended then the color from the cpt file is applied to symbol fill
Expand Down

0 comments on commit 001822f

Please sign in to comment.