Skip to content

Commit 9a8ec58

Browse files
Update Figure.coast docstrings (#798)
Co-authored-by: Dongdong Tian <[email protected]>
1 parent 30e7470 commit 9a8ec58

File tree

1 file changed

+80
-18
lines changed

1 file changed

+80
-18
lines changed

pygmt/base_plotting.py

+80-18
Original file line numberDiff line numberDiff line change
@@ -108,44 +108,106 @@ def coast(self, **kwargs):
108108
{J}
109109
{R}
110110
area_thresh : int, float, or str
111-
``'min_area[/min_level/max_level][+ag|i|s|S][+r|l][+ppercent]'``
111+
*min_area*\ [/*min_level*/*max_level*][**+ag**\|\ **i**\
112+
\|\ **s**\|\ **S**][**+r**\|\ **l**][**+p**\
113+
*percent*].
112114
Features with an area smaller than min_area in km^2 or of
113115
hierarchical level that is lower than min_level or higher than
114116
max_level will not be plotted.
115117
{B}
116118
lakes : str or list
117-
*fill*\ [**+l**\ |**+r**\ ]
119+
*fill*\ [**+l**\|\ **+r**].
118120
Set the shade, color, or pattern for lakes and river-lakes. The
119121
default is the fill chosen for wet areas set by the ``water``
120122
argument. Optionally, specify separate fills by appending
121123
**+l** for lakes or **+r** for river-lakes, and passing multiple
122124
strings in a list.
123125
resolution : str
124-
Selects the resolution of the data set to use ((f)ull, (h)igh,
125-
(i)ntermediate, (l)ow, and (c)rude).
126+
**f**\|\ **h**\|\ **i**\|\ **l**\|\ **c**.
127+
Selects the resolution of the data set to: (**f**\ )ull,
128+
(**h**\ )igh, (**i**\ )ntermediate, (**l**\ )ow,
129+
and (**c**\ )rude.
126130
land : str
127131
Select filling or clipping of “dry” areas.
128-
rivers : str
129-
``'river[/pen]'``
130-
Draw rivers. Specify the type of rivers and [optionally] append pen
131-
attributes.
132+
rivers : int or str or list
133+
*river*\ [/*pen*].
134+
Draw rivers. Specify the type of rivers and [optionally] append
135+
pen attributes [Default pen: width = default, color = black,
136+
style = solid].
137+
138+
Choose from the list of river types below; pass a list to
139+
``rivers`` to use multiple arguments.
140+
141+
0 = Double-lined rivers (river-lakes)
142+
143+
1 = Permanent major rivers
144+
145+
2 = Additional major rivers
146+
147+
3 = Additional rivers
148+
149+
4 = Minor rivers
150+
151+
5 = Intermittent rivers - major
152+
153+
6 = Intermittent rivers - additional
154+
155+
7 = Intermittent rivers - minor
156+
157+
8 = Major canals
158+
159+
9 = Minor canals
160+
161+
10 = Irrigation canals
162+
163+
You can also choose from several preconfigured river groups:
164+
165+
a = All rivers and canals (0-10)
166+
167+
A = All rivers and canals except river-lakes (1-10)
168+
169+
r = All permanent rivers (0-4)
170+
171+
R = All permanent rivers except river-lakes (1-4)
172+
173+
i = All intermittent rivers (5-7)
174+
175+
c = All canals (8-10)
132176
map_scale : str
133-
``'[g|j|J|n|x]refpoint'``
177+
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*.
134178
Draws a simple map scale centered on the reference point specified.
135-
borders : str
136-
``'border[/pen]'``
179+
borders : int or str or list
180+
*border*\ [/*pen*].
137181
Draw political boundaries. Specify the type of boundary and
138-
[optionally] append pen attributes
182+
[optionally] append pen attributes [Default pen: width = default,
183+
color = black, style = solid].
184+
185+
Choose from the list of boundaries below. Pass a list to
186+
``borders`` to use multiple arguments.
187+
188+
1 = National boundaries
189+
190+
2 = State boundaries within the Americas
191+
192+
3 = Marine boundaries
193+
194+
a = All boundaries (1-3)
139195
water : str
140196
Select filling or clipping of “wet” areas.
141197
{U}
142-
{V}
143-
shorelines : str
144-
``'[level/]pen'``
145-
Draw shorelines [Default is no shorelines]. Append pen attributes.
198+
shorelines : int or str or list
199+
[*level*\ /]\ *pen*.
200+
Draw shorelines [Default is no shorelines]. Append pen attributes
201+
[Defaults: width = default, color = black, style = solid] which
202+
apply to all four levels. To set the pen for a single level,
203+
pass a string with *level*\ /*pen*\ , where level is
204+
1-4 and represent coastline, lakeshore, island-in-lake shore, and
205+
lake-in-island-in-lake shore. Pass a list of *level*\ /*pen*
206+
strings to ``shorelines`` to set multiple levels. When specific
207+
level pens are set, those not listed will not be drawn.
146208
dcw : str or list
147209
*code1,code2,…*\ [**+l**\|\ **L**\ ][**+g**\ *fill*\ ]
148-
[**+p**\ *pen*\ ][**+z**]
210+
[**+p**\ *pen*\ ][**+z**].
149211
Select painting or dumping country polygons from the
150212
`Digital Chart of the World
151213
<https://en.wikipedia.org/wiki/Digital_Chart_of_the_World>`__.
@@ -165,7 +227,7 @@ def coast(self, **kwargs):
165227
{XY}
166228
{p}
167229
{t}
168-
230+
{V}
169231
"""
170232
kwargs = self._preprocess(**kwargs)
171233
if not args_in_kwargs(args=["C", "G", "S", "I", "N", "Q", "W"], kwargs=kwargs):

0 commit comments

Comments
 (0)