Skip to content

Commit e30b2d7

Browse files
Update plotting module docstrings to use parameter vs. argument (#956)
* Update blockmedian.py * Update coast.py * Update grd2cpt.py * Update grdinfo.py * Update text.py * Update pygmt/src/text.py
1 parent c7736c1 commit e30b2d7

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

pygmt/src/blockmedian.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def blockmedian(table, outfile=None, **kwargs):
2525
Reads arbitrarily located (x,y,z) triples [or optionally weighted
2626
quadruples (x,y,z,w)] from a table and writes to the output a median
2727
position and value for every non-empty block in a grid region defined by
28-
the region and spacing arguments.
28+
the ``region`` and ``spacing`` parameters.
2929
3030
Full option list at :gmt-docs:`blockmedian.html`
3131

pygmt/src/coast.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def coast(self, **kwargs):
7676
*fill*\ [**+l**\|\ **+r**].
7777
Set the shade, color, or pattern for lakes and river-lakes. The
7878
default is the fill chosen for wet areas set by the ``water``
79-
argument. Optionally, specify separate fills by appending
79+
parameter. Optionally, specify separate fills by appending
8080
**+l** for lakes or **+r** for river-lakes, and passing multiple
8181
strings in a list.
8282
resolution : str
@@ -189,7 +189,7 @@ def coast(self, **kwargs):
189189
kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
190190
if not args_in_kwargs(args=["C", "G", "S", "I", "N", "E", "Q", "W"], kwargs=kwargs):
191191
raise GMTInvalidInput(
192-
"""At least one of the following arguments must be specified:
192+
"""At least one of the following parameters must be specified:
193193
lakes, land, water, rivers, borders, dcw, Q, or shorelines"""
194194
)
195195
with Session() as lib:

pygmt/src/grd2cpt.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def grd2cpt(grid, **kwargs):
130130
the CPT alone. The truncation takes place before any resampling. See
131131
also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
132132
output : str
133-
Optional argument to set the file name with extension .cpt to store
133+
Optional parameter to set the file name with extension .cpt to store
134134
the generated CPT file. If not given or False (default), saves the CPT
135135
as the session current CPT.
136136
reverse : str

pygmt/src/grdinfo.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ def grdinfo(grid, **kwargs):
3939
----------
4040
grid : str or xarray.DataArray
4141
The file name of the input grid or the grid loaded as a DataArray.
42-
This is the only required argument.
42+
This is the only required parameter.
4343
{R}
4444
per_column : str or bool
4545
**n**\|\ **t**.
4646
Formats the report using tab-separated fields on a single line. The
4747
output is name *w e s n z0 z1 dx dy nx ny* [ *x0 y0 x1 y1* ]
4848
[ *med scale* ] [ *mean std rms* ] [ *n_nan* ] *registration gtype*.
4949
The data in brackets are outputted depending on the ``force_scan``
50-
and ``minmax_pos`` arguments. Use **t** to place file name at the end
50+
and ``minmax_pos`` parameters. Use **t** to place file name at the end
5151
of the output record or, **n** or ``True`` to only output numerical
5252
columns. The registration is either 0 (gridline) or 1 (pixel), while
5353
gtype is either 0 (Cartesian) or 1 (geographic). The default value is

pygmt/src/text.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ def text_(
165165
if kind == "vectors" and text is None:
166166
raise GMTInvalidInput("Must provide text with x/y pairs or position")
167167

168-
# Build the `-F` argument in gmt text.
168+
# Build the -F option in gmt text.
169169
if "F" not in kwargs.keys() and (
170170
(
171171
position is not None

0 commit comments

Comments
 (0)