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 region and projection standard docstrings #1510

Merged
merged 8 commits into from
Oct 12, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
4 changes: 0 additions & 4 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,10 @@
COMMON_OPTIONS = {
"R": r"""
region : str or list
*Required if this is the first plot command*.
*xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
Specify the :doc:`region </tutorials/regions>` of interest.""",
"J": r"""
projection : str
*Required if this is the first plot command*.
*projcode*\[*projparams*/]\ *width*.
Select map :doc:`projection </projections/index>`.""",
"A": r"""
Expand Down Expand Up @@ -448,11 +446,9 @@ def fmt_docstring(module_func):
data variables, or a :class:`geopandas.GeoDataFrame` containing the
tabular data.
region : str or list
*Required if this is the first plot command*.
*xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
Specify the :doc:`region </tutorials/regions>` of interest.
projection : str
*Required if this is the first plot command*.
*projcode*\[*projparams*/]\ *width*.
Select map :doc:`projection </projections/index>`.
<BLANKLINE>
Expand Down
1 change: 1 addition & 0 deletions pygmt/src/basemap.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ def basemap(self, **kwargs):
zscale/zsize : float or str
Set z-axis scaling or z-axis size.
{R}
*Required if this is the first plot command.*
{B}
map_scale : str
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
Expand Down
1 change: 1 addition & 0 deletions pygmt/src/coast.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ def coast(self, **kwargs):
----------
{J}
{R}
*Required if this is the first plot command.*
{A}
{B}
lakes : str or list
Expand Down
1 change: 1 addition & 0 deletions pygmt/src/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ def text_(
then the input to ``textfiles`` must have this as a column.
{J}
{R}
*Required if this is the first plot command.*
clearance : str
[*dx/dy*][**+to**\|\ **O**\|\ **c**\|\ **C**].
Adjust the clearance between the text and the surrounding box
Expand Down