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 the doc strings in the non-plotting modules #882

Merged
merged 26 commits into from
Feb 14, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
6b79637
Update doc strings for makecpt.py
willschlitzer Feb 13, 2021
9069441
Update doc strings for savefig in figure.py
willschlitzer Feb 13, 2021
b83b210
Update doc strings for psconvert in figure.py
willschlitzer Feb 13, 2021
e612529
Update doc strings in blockmedian.py
willschlitzer Feb 13, 2021
8fc0223
Update doc strings in surface.py
willschlitzer Feb 13, 2021
3ae6d0d
Update doc strings in grdcut.py
willschlitzer Feb 13, 2021
a7764ee
Update doc strings in grdfilter.py
willschlitzer Feb 13, 2021
55965dd
Update doc strings in x2sys.py
willschlitzer Feb 13, 2021
1289884
Update doc strings for x2sys_cross in x2sys.py
willschlitzer Feb 13, 2021
6f9379e
Update doc strings for info.py
willschlitzer Feb 13, 2021
6a2c992
Make changed doc strings raw strings
willschlitzer Feb 13, 2021
6f4f25d
Update fmt docstring
willschlitzer Feb 14, 2021
5f1fd46
Formatting fixes
willschlitzer Feb 14, 2021
0c08776
Update output docstring in info.py
willschlitzer Feb 14, 2021
8bcd2ab
Update formatting in makecpt.py
willschlitzer Feb 14, 2021
de9de6d
Apply suggestions from code review
willschlitzer Feb 14, 2021
a84649e
Formatting fixes
willschlitzer Feb 14, 2021
4e6c6d2
Formatting fix
willschlitzer Feb 14, 2021
3cd7330
Merge branch 'master' into docstring-format-non-plotting
willschlitzer Feb 14, 2021
c57bc9d
Apply suggestions from code review
willschlitzer Feb 14, 2021
62e694d
Format fix
willschlitzer Feb 14, 2021
3edc108
Apply suggestions from code review
willschlitzer Feb 14, 2021
3619286
Format fix
willschlitzer Feb 14, 2021
59808ee
Format fix
willschlitzer Feb 14, 2021
029fd32
Merge branch 'master' into docstring-format-non-plotting
willschlitzer Feb 14, 2021
a836e28
Merge branch 'master' into docstring-format-non-plotting
willschlitzer Feb 14, 2021
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
Apply suggestions from code review
Co-authored-by: Dongdong Tian <[email protected]>
  • Loading branch information
willschlitzer and seisman committed Feb 14, 2021
commit 3edc108616eea993c072abd22beda9f9ee140190
12 changes: 6 additions & 6 deletions pygmt/src/makecpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def makecpt(**kwargs):
the new master file. If not, the parameters :gmt-term:`COLOR_BACKGROUND`,
:gmt-term:`COLOR_FOREGROUND`, and :gmt-term:`COLOR_NAN` from the
:gmt-docs:`gmt.conf <gmt.conf>` file or the command line will be used. This
default behavior can be overruled using the options ``background``,
default behavior can be overruled using the parameters ``background``,
``overrule_bg`` or ``no_bg``.

The color model (RGB, HSV or CMYK) of the palette created by **makecpt**
Expand Down Expand Up @@ -81,7 +81,7 @@ def makecpt(**kwargs):
``background='i'`` to match the colors for the lowest and highest
values in the input (instead of the output) CPT.
color_model :
[**R**\|\ **r**\|\ **h**\|\ **c**\ ][**+c**\ [*label*\ ]].
[**R**\|\ **r**\|\ **h**\|\ **c**][**+c**\ [*label*]].
Force output CPT to be written with r/g/b codes, gray-scale values or
color name (**R**, default) or r/g/b codes only (**r**), or h-s-v codes
(**h**), or c/m/y/k codes (**c**). Optionally or alternatively, append
Expand All @@ -90,10 +90,10 @@ def makecpt(**kwargs):
CPT is plotted. The *label* may be a comma-separated list of category
names (you can skip a category by not giving a name), or give
*start*[-], where we automatically build monotonically increasing
labels from *start*\ (a single letter or an integer). Append - to build
labels from *start* (a single letter or an integer). Append - to build
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
ranges *start*-*start+1* instead.
series : list or str
[*min/max/inc*\ [**+b**\|\ **l**\|\ **n**\ ]\|\ *file*\|\ *list*\ ].
[*min/max/inc*\[**+b**\|\ **l**\|\ **n**]\|\ *file*\|\ *list*].
Defines the range of the new CPT by giving the lowest and highest
z-value (and optionally an interval). If this is not given, the
existing range in the master CPT will be used intact. The values
Expand All @@ -102,9 +102,9 @@ def makecpt(**kwargs):
For details on array creation, see
:gmt-docs:`makecpt.html#generate-1d-array`.
truncate : list or str
*zlo/zhi*\ .
*zlow/zhigh*.
Truncate the incoming CPT so that the lowest and highest z-levels are
to *zlo* and *zhi*. If one of these equal NaN then we leave that end of
to *zlow* and *zhigh*. If one of these equal NaN then we leave that end of
the CPT alone. The truncation takes place before any resampling. See
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
output : str
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/surface.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ def surface(x=None, y=None, z=None, data=None, **kwargs):
Either a data file name or a 2d numpy array with the tabular data.

spacing : str
*xinc*\[\ *unit*\][**+e**\|\ **n**]
*xinc*\[\ *unit*\][**+e**\|\ **n**]\
[/*yinc*\ [*unit*][**+e**\|\ **n**]].
*xinc* [and optionally *yinc*] is the grid spacing.

region : str or list
*xmin/xmax/ymin/ymax*\[\ **+r**\][**+u**\ *unit*].
*xmin/xmax/ymin/ymax*\[**+r**][**+u**\ *unit*].
Specify the region of interest.

outfile : str
Expand Down
2 changes: 1 addition & 1 deletion pygmt/x2sys.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ def x2sys_init(tag, **kwargs):
[Default]). If not given we assume the data are Cartesian.

spacing : str or list
*dx*\[/*dy*\].
*dx*\[/*dy*].
*dx* [and optionally *dy*] is the grid spacing. Append **m** to
indicate minutes or **s** to indicate seconds for geographic data.
These spacings refer to the binning used in the track bin-index data
Expand Down