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
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
Update formatting in makecpt.py
  • Loading branch information
willschlitzer committed Feb 14, 2021
commit 8bcd2ab043cd07313a42fe487a3acc48a940fb5b
14 changes: 7 additions & 7 deletions pygmt/src/makecpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def makecpt(**kwargs):

This is a module that will help you make static color palette tables
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
(CPTs). By default, the CPT will simply be saved to the current session,
but you can use *output* to save it to a file. You define an equidistant
but you can use ``output`` to save it to a file. You define an equidistant
set of contour intervals or pass your own z-table or list, and create a new
CPT based on an existing master (dynamic) CPT. The resulting CPT can be
reversed relative to the master cpt, and can be made continuous or
Expand All @@ -49,8 +49,8 @@ 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*,
*overrule_bg* or *no_bg*.
default behavior can be overruled using the options ``background``,
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
``overrule_bg`` or ``no_bg``.

The color model (RGB, HSV or CMYK) of the palette created by **makecpt**
will be the same as specified in the header of the master CPT. When there
Expand Down Expand Up @@ -90,7 +90,7 @@ 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*\ ].
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -112,11 +112,11 @@ def makecpt(**kwargs):
file. If not given or False (default), saves the CPT as the session
current CPT.
reverse : str
Set this to True or c [Default] to reverse the sense of color
Set this to True or **c**\ [Default] to reverse the sense of color
progression in the master CPT. Set this to z to reverse the sign of
z-values in the color table. Note that this change of z-direction
happens before *truncate* and *series* values are used so the latter
must be compatible with the changed *z*-range. See also
happens before ``truncate`` and ``series`` values are used so the
latter must be compatible with the changed *z*-range. See also
:gmt-docs:`cookbook/features.html#manipulating-cpts`.
overrule_bg : str
Overrule background, foreground, and NaN colors specified in the master
Expand Down