Skip to content

Commit 975ab3b

Browse files
michaelgrundMeghan Jonesweiji14
authored
Add area_thresh to COMMON_OPTIONS (#1426)
* update pygmt/helpers/decorators.py * update docstring in coast Co-authored-by: Meghan Jones <[email protected]> Co-authored-by: Wei Ji <[email protected]>
1 parent 85d78d6 commit 975ab3b

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

pygmt/helpers/decorators.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@
2525
*Required if this is the first plot command*.
2626
*projcode*\[*projparams*/]\ *width*.
2727
Select map :doc:`projection </projections/index>`.""",
28+
"A": r"""
29+
area_thresh : int or float or str
30+
*min_area*\ [/*min_level*/*max_level*][**+a**\[**g**\|\ **i**]\
31+
[**s**\|\ **S**]][**+l**\|\ **r**][**+p**\ *percent*].
32+
Features with an area smaller than *min_area* in km\ :sup:`2` or of
33+
hierarchical level that is lower than *min_level* or higher than
34+
*max_level* will not be plotted [Default is 0/0/4 (all
35+
features)].""",
2836
"B": r"""
2937
frame : bool or str or list
3038
Set map boundary

pygmt/src/coast.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,7 @@ def coast(self, **kwargs):
6565
----------
6666
{J}
6767
{R}
68-
area_thresh : int, float, or str
69-
*min_area*\ [/*min_level*/*max_level*][**+a**\[**g**\|\ **i**]\
70-
[**s**\|\ **S**][**+l**\|\ **r**][**+p**\ *percent*].
71-
Features with an area smaller than *min_area* in km\ :sup:`2` or of
72-
hierarchical level that is lower than *min_level* or higher than
73-
*max_level* will not be plotted.
68+
{A}
7469
{B}
7570
lakes : str or list
7671
*fill*\ [**+l**\|\ **+r**].

0 commit comments

Comments
 (0)