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 1 commit
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
Prev Previous commit
Next Next commit
update docstring requirements
  • Loading branch information
willschlitzer committed Sep 14, 2021
commit 8ef09f3f7cc2f0f1adb32da3644906d33f7be61b
2 changes: 2 additions & 0 deletions pygmt/src/basemap.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,11 @@ def basemap(self, **kwargs):
Parameters
----------
{J}
*Required if this is the first plot command.*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
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
2 changes: 2 additions & 0 deletions pygmt/src/coast.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ def coast(self, **kwargs):
Parameters
----------
{J}
*Required if this is the first plot command.*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
{R}
*Required if this is the first plot command.*
{A}
{B}
lakes : str or list
Expand Down
2 changes: 2 additions & 0 deletions pygmt/src/histogram.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ def histogram(self, table, **kwargs):
Pass in either a file name to an ASCII data table, a Python list, a 2D
{table-classes}.
{J}
*Required if this is the first plot command.*
{R}
*Required if this is the first plot command.*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
{B}
{CPT}
{G}
Expand Down
2 changes: 2 additions & 0 deletions pygmt/src/solar.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ def solar(self, terminator="d", terminator_datetime=None, **kwargs):
passed as a string or Python datetime object.
[Default is the current UTC date and time]
{R}
*Required if this is the first plot command.*
{J}
*Required if this is the first plot command.*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
{B}
fill : str
Color or pattern for filling of terminators.
Expand Down
2 changes: 2 additions & 0 deletions pygmt/src/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,9 @@ def text_(
left. If no justification is explicitly given (i.e. ``justify=True``),
then the input to ``textfiles`` must have this as a column.
{J}
*Required if this is the first plot command.*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
{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