Skip to content

Commit 8ef09f3

Browse files
committed
update docstring requirements
1 parent f61caea commit 8ef09f3

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

pygmt/src/basemap.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,11 @@ def basemap(self, **kwargs):
5252
Parameters
5353
----------
5454
{J}
55+
*Required if this is the first plot command.*
5556
zscale/zsize : float or str
5657
Set z-axis scaling or z-axis size.
5758
{R}
59+
*Required if this is the first plot command.*
5860
{B}
5961
map_scale : str
6062
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\

pygmt/src/coast.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ def coast(self, **kwargs):
6464
Parameters
6565
----------
6666
{J}
67+
*Required if this is the first plot command.*
6768
{R}
69+
*Required if this is the first plot command.*
6870
{A}
6971
{B}
7072
lakes : str or list

pygmt/src/histogram.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ def histogram(self, table, **kwargs):
5454
Pass in either a file name to an ASCII data table, a Python list, a 2D
5555
{table-classes}.
5656
{J}
57+
*Required if this is the first plot command.*
5758
{R}
59+
*Required if this is the first plot command.*
5860
{B}
5961
{CPT}
6062
{G}

pygmt/src/solar.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ def solar(self, terminator="d", terminator_datetime=None, **kwargs):
5050
passed as a string or Python datetime object.
5151
[Default is the current UTC date and time]
5252
{R}
53+
*Required if this is the first plot command.*
5354
{J}
55+
*Required if this is the first plot command.*
5456
{B}
5557
fill : str
5658
Color or pattern for filling of terminators.

pygmt/src/text.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ def text_(
116116
left. If no justification is explicitly given (i.e. ``justify=True``),
117117
then the input to ``textfiles`` must have this as a column.
118118
{J}
119+
*Required if this is the first plot command.*
119120
{R}
121+
*Required if this is the first plot command.*
120122
clearance : str
121123
[*dx/dy*][**+to**\|\ **O**\|\ **c**\|\ **C**].
122124
Adjust the clearance between the text and the surrounding box

0 commit comments

Comments
 (0)