Skip to content

Commit

Permalink
Minor docs improvements (#386)
Browse files Browse the repository at this point in the history
Update B decorator to "str or list" and add alias `map_scale` for L to `basemap`.
  • Loading branch information
kmaterna authored and weiji14 committed Dec 23, 2019
1 parent fff0d5c commit 2bc5f7d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions pygmt/base_plotting.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ def _preprocess(self, **kwargs): # pylint: disable=no-self-use
B="frame",
D="resolution",
I="rivers",
L="map_scale",
N="borders",
W="shorelines",
G="land",
Expand Down Expand Up @@ -115,6 +116,9 @@ def coast(self, **kwargs):
``'river[/pen]'``
Draw rivers. Specify the type of rivers and [optionally] append pen
attributes.
L : str
``'[g|j|J|n|x]refpoint'``
Draws a simple map scale centered on the reference point specified.
N : str
``'border[/pen]'``
Draw political boundaries. Specify the type of boundary and
Expand Down
2 changes: 1 addition & 1 deletion pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
*Required if this is the first plot command*.
Select map projection.""",
"B": """\
B : str
B : str or list
Set map boundary frame and axes attributes.""",
"U": """\
U : bool or str
Expand Down

0 comments on commit 2bc5f7d

Please sign in to comment.