From 001822f015a295d18315e8baaac7b411faf961d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= <94163266+yvonnefroehlich@users.noreply.github.com> Date: Sun, 25 Sep 2022 15:13:45 +0200 Subject: [PATCH] Fix default for `pen` parameter in API documentation (#2134) --- pygmt/src/coast.py | 9 ++++----- pygmt/src/solar.py | 3 +-- pygmt/src/text.py | 3 +-- pygmt/src/velo.py | 2 +- 4 files changed, 7 insertions(+), 10 deletions(-) diff --git a/pygmt/src/coast.py b/pygmt/src/coast.py index 683d345d657..403d89b7d18 100644 --- a/pygmt/src/coast.py +++ b/pygmt/src/coast.py @@ -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. @@ -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. @@ -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 diff --git a/pygmt/src/solar.py b/pygmt/src/solar.py index 350330a1021..f48c1a57d7f 100644 --- a/pygmt/src/solar.py +++ b/pygmt/src/solar.py @@ -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} diff --git a/pygmt/src/text.py b/pygmt/src/text.py index 79f2091134d..779d678c01b 100644 --- a/pygmt/src/text.py +++ b/pygmt/src/text.py @@ -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} diff --git a/pygmt/src/velo.py b/pygmt/src/velo.py index 84c577f3872..6d93822b876 100644 --- a/pygmt/src/velo.py +++ b/pygmt/src/velo.py @@ -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