Skip to content
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

Update GMT arguments in coast doc strings #798

Merged
merged 30 commits into from
Jan 26, 2021
Merged
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
27f5d20
Add cyl_transverse_mercator.py
willschlitzer Dec 11, 2020
d64983f
Add cyl_universal_transverse_mercator.py
willschlitzer Dec 11, 2020
6ba8185
Changing land color to red in cyl_mercator.py to match GMT docs examp…
willschlitzer Dec 11, 2020
76850ee
Merge branch 'master' into cylindrical-projections
willschlitzer Dec 13, 2020
48431db
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 12, 2021
01052d2
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 18, 2021
c710988
Merge remote-tracking branch 'origin/master'
willschlitzer Jan 21, 2021
2283f4e
Update doc string for area_thresh
willschlitzer Jan 21, 2021
94d953a
Update doc string for resolution
willschlitzer Jan 21, 2021
6c7b6f2
Update doc string for rivers
willschlitzer Jan 21, 2021
02212f1
Update doc string for map_scale
willschlitzer Jan 21, 2021
8df4345
Update doc string for borders
willschlitzer Jan 21, 2021
ef8c3d0
Update doc string for shorelines
willschlitzer Jan 21, 2021
02fc80b
Fixing typo in doc string for shorelines
willschlitzer Jan 21, 2021
dac7275
Fixing typo in doc string for shorelines
willschlitzer Jan 21, 2021
0d79d2c
Merge branch 'master' into coast-docstring
willschlitzer Jan 21, 2021
5237bf8
Expand doc string for rivers and borders
willschlitzer Jan 22, 2021
a426d35
Expand doc string for shorelines
willschlitzer Jan 22, 2021
68fdf34
Merge branch 'master' into coast-docstring
willschlitzer Jan 22, 2021
f02f141
Fix typo
willschlitzer Jan 22, 2021
42fdd03
Update pygmt/base_plotting.py
willschlitzer Jan 24, 2021
83b04c7
Merge branch 'master' into coast-docstring
willschlitzer Jan 24, 2021
b30b632
Cancel vertical bars
willschlitzer Jan 24, 2021
0f5093e
Add fullstop periods after syntax example
willschlitzer Jan 24, 2021
9b00dc4
Update doc string formatting
willschlitzer Jan 24, 2021
0f76924
Fix format
willschlitzer Jan 24, 2021
01f088f
Merge branch 'master' into coast-docstring
seisman Jan 24, 2021
30ea8b4
Apply suggestions from code review
seisman Jan 26, 2021
4ecdc27
Merge branch 'master' into coast-docstring
seisman Jan 26, 2021
9490cf0
Update pygmt/base_plotting.py
seisman Jan 26, 2021
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
98 changes: 80 additions & 18 deletions pygmt/base_plotting.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,44 +108,106 @@ def coast(self, **kwargs):
{J}
{R}
area_thresh : int, float, or str
``'min_area[/min_level/max_level][+ag|i|s|S][+r|l][+ppercent]'``
*min_area*\ [/*min_level*/*max_level*][**+ag**\|\ **i**\
\|\ **s**\|\ **S**][**+r**\|\ **l**][**+p**\
*percent*].
Features with an area smaller than min_area in km^2 or of
hierarchical level that is lower than min_level or higher than
max_level will not be plotted.
{B}
lakes : str or list
*fill*\ [**+l**\ |**+r**\ ]
*fill*\ [**+l**\|\ **+r**].
Set the shade, color, or pattern for lakes and river-lakes. The
default is the fill chosen for wet areas set by the ``water``
argument. Optionally, specify separate fills by appending
**+l** for lakes or **+r** for river-lakes, and passing multiple
strings in a list.
resolution : str
Selects the resolution of the data set to use ((f)ull, (h)igh,
(i)ntermediate, (l)ow, and (c)rude).
**f**\|\ **h**\|\ **i**\|\ **l**\|\ **c**.
Selects the resolution of the data set to: (**f**\ )ull,
(**h**\ )igh, (**i**\ )ntermediate, (**l**\ )ow,
and (**c**\ )rude.
land : str
Select filling or clipping of “dry” areas.
rivers : str
``'river[/pen]'``
Draw rivers. Specify the type of rivers and [optionally] append pen
attributes.
rivers : int or str or list
*river*\ [/*pen*].
Draw rivers. Specify the type of rivers and [optionally] append
pen attributes [Default pen: width = default, color = black,
style = solid].

Choose from the list of river types below; pass a list to
``rivers`` to use multiple arguments.

0 = Double-lined rivers (river-lakes)

1 = Permanent major rivers

2 = Additional major rivers

3 = Additional rivers

4 = Minor rivers

5 = Intermittent rivers - major

6 = Intermittent rivers - additional

7 = Intermittent rivers - minor

8 = Major canals

9 = Minor canals

10 = Irrigation canals

You can also choose from several preconfigured river groups:

a = All rivers and canals (0-10)

A = All rivers and canals except river-lakes (1-10)

r = All permanent rivers (0-4)

R = All permanent rivers except river-lakes (1-4)

i = All intermittent rivers (5-7)

c = All canals (8-10)
map_scale : str
``'[g|j|J|n|x]refpoint'``
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*.
Draws a simple map scale centered on the reference point specified.
borders : str
``'border[/pen]'``
borders : int or str or list
*border*\ [/*pen*].
Draw political boundaries. Specify the type of boundary and
[optionally] append pen attributes
[optionally] append pen attributes [Default pen: width = default,
color = black, style = solid].

Choose from the list of boundaries below. Pass a list to
``borders`` to use multiple arguments.

1 = National boundaries

2 = State boundaries within the Americas

3 = Marine boundaries

a = All boundaries (1-3)
water : str
Select filling or clipping of “wet” areas.
{U}
{V}
shorelines : str
``'[level/]pen'``
Draw shorelines [Default is no shorelines]. Append pen attributes.
shorelines : int or str or list
[*level*\ /]\ *pen*.
Draw shorelines [Default is no shorelines]. Append pen attributes
[Defaults: width = default, color = black, style = 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
lake-in-island-in-lake shore. Pass a list of *level*\ /*pen*
strings to ``shorelines`` to set multiple levels. When specific
level pens are set, those not listed will not be drawn.
dcw : str or list
*code1,code2,…*\ [**+l**\|\ **L**\ ][**+g**\ *fill*\ ]
[**+p**\ *pen*\ ][**+z**]
[**+p**\ *pen*\ ][**+z**].
Select painting or dumping country polygons from the
`Digital Chart of the World
<https://en.wikipedia.org/wiki/Digital_Chart_of_the_World>`__.
Expand All @@ -165,7 +227,7 @@ def coast(self, **kwargs):
{XY}
{p}
{t}

{V}
"""
kwargs = self._preprocess(**kwargs)
if not args_in_kwargs(args=["C", "G", "S", "I", "N", "Q", "W"], kwargs=kwargs):
Expand Down