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
Formatting fixes
  • Loading branch information
willschlitzer committed Feb 14, 2021
commit 5f1fd460171530abf5afcc15e52c31fb4608030a
3 changes: 2 additions & 1 deletion pygmt/src/blockmedian.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ def blockmedian(table, outfile=None, **kwargs):
Specify the region of interest.

outfile : str
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
Required if 'table' is a file. The file name for the output ASCII file.
Required if ``table`` is a file. The file name for the output ASCII
file.

{V}

Expand Down
12 changes: 6 additions & 6 deletions pygmt/src/grdfilter.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ def grdfilter(grid, **kwargs):
Filter a grid file in the time domain using one of the selected convolution
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
or non-convolution isotropic or rectangular filters and compute distances
using Cartesian or Spherical geometries. The output grid file can
optionally be generated as a sub-region of the input (via *region*) and/or
with new increment (via *spacing*) or registration (via *toggle*). In this
way, one may have "extra space" in the input data so that the edges will
not be used and the output can be within one half-width of the input edges.
If the filter is low-pass, then the output may be less frequently sampled
than the input.
optionally be generated as a sub-region of the input (via ``region``)
and/or with new increment (via ``spacing``) or registration
(via ``toggle``). In this way, one may have "extra space" in the input
data so that the edges will not be used and the output can be within one
half-width of the input edges. If the filter is low-pass, then the output
may be less frequently sampled than the input.

Full option list at :gmt-docs:`grdfilter.html`

Expand Down
11 changes: 6 additions & 5 deletions pygmt/src/info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ def info(table, **kwargs):
find the extent of the first two columns rounded up and down to the nearest
multiple of the supplied increments given by *spacing*. Such output will be
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
in a numpy.ndarray form ``[w, e, s, n]``, which can be used directly as the
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
*region* argument for other modules (hence only dx and dy are needed). If
the *per_column* option is combined with *spacing*, then the numpy.ndarray
output will be rounded up/down for as many columns as there are increments
provided in *spacing*. A similar option *nearest_multiple* option will
provide a numpy.ndarray in the form of ``[zmin, zmax, dz]`` for makecpt.
``region`` argument for other modules (hence only dx and dy are needed).
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
If the ``per_column`` option is combined with ``spacing``, then the
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
numpy.ndarray output will be rounded up/down for as many columns as there
are increments provided in ``spacing``. A similar option
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
``nearest_multiple`` option will provide a numpy.ndarray in the form of
``[zmin, zmax, dz]`` for makecpt.
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved

Full option list at :gmt-docs:`gmtinfo.html`

Expand Down