Skip to content

Update plotting module docstrings to use parameter vs. argument #956

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

Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion pygmt/src/blockmedian.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def blockmedian(table, outfile=None, **kwargs):
Reads arbitrarily located (x,y,z) triples [or optionally weighted
quadruples (x,y,z,w)] from a table and writes to the output a median
position and value for every non-empty block in a grid region defined by
the region and spacing arguments.
the ``region`` and ``spacing`` parameters.
Full option list at :gmt-docs:`blockmedian.html`
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/coast.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def coast(self, **kwargs):
*fill*\ [**+l**\|\ **+r**].
Set the shade, color, or pattern for lakes and river-lakes. The
default is the fill chosen for wet areas set by the ``water``
argument. Optionally, specify separate fills by appending
parameter. Optionally, specify separate fills by appending
**+l** for lakes or **+r** for river-lakes, and passing multiple
strings in a list.
resolution : str
Expand Down Expand Up @@ -189,7 +189,7 @@ def coast(self, **kwargs):
kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
if not args_in_kwargs(args=["C", "G", "S", "I", "N", "E", "Q", "W"], kwargs=kwargs):
raise GMTInvalidInput(
"""At least one of the following arguments must be specified:
"""At least one of the following parameters must be specified:
lakes, land, water, rivers, borders, dcw, Q, or shorelines"""
)
with Session() as lib:
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/grd2cpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def grd2cpt(grid, **kwargs):
the CPT alone. The truncation takes place before any resampling. See
also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
output : str
Optional argument to set the file name with extension .cpt to store
Optional parameter to set the file name with extension .cpt to store
the generated CPT file. If not given or False (default), saves the CPT
as the session current CPT.
reverse : str
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ def grdinfo(grid, **kwargs):
----------
grid : str or xarray.DataArray
The file name of the input grid or the grid loaded as a DataArray.
This is the only required argument.
This is the only required parameter.
{R}
per_column : str or bool
**n**\|\ **t**.
Formats the report using tab-separated fields on a single line. The
output is name *w e s n z0 z1 dx dy nx ny* [ *x0 y0 x1 y1* ]
[ *med scale* ] [ *mean std rms* ] [ *n_nan* ] *registration gtype*.
The data in brackets are outputted depending on the ``force_scan``
and ``minmax_pos`` arguments. Use **t** to place file name at the end
and ``minmax_pos`` parameters. Use **t** to place file name at the end
of the output record or, **n** or ``True`` to only output numerical
columns. The registration is either 0 (gridline) or 1 (pixel), while
gtype is either 0 (Cartesian) or 1 (geographic). The default value is
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ def text_(
if kind == "vectors" and text is None:
raise GMTInvalidInput("Must provide text with x/y pairs or position")

# Build the `-F` argument in gmt text.
# Build the -F option in gmt text.
if "F" not in kwargs.keys() and (
(
position is not None
Expand Down