Skip to content

Commit ebc807e

Browse files
committed
Replace argument with parameter as per #886
1 parent e0900e9 commit ebc807e

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

examples/tutorials/subplots.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
# all subsequent plotting functions will take place in that subplot panel. This
6767
# is similar to matplotlib's ``plt.sca`` method. In order to specify a subplot,
6868
# you will need to provide the identifier for that subplot via the ``panel``
69-
# argument. Pass in either the *index* number, or a tuple/list like
69+
# parameter. Pass in either the *index* number, or a tuple/list like
7070
# (*row*, *col*) to ``panel``.
7171

7272
###############################################################################
@@ -91,7 +91,7 @@
9191
# Making your first subplot
9292
# -------------------------
9393
# Next, let's use what we learned above to make a 2 row by 2 column subplot
94-
# figure. We'll also pick up on some new arguments to configure our subplot.
94+
# figure. We'll also pick up on some new parameters to configure our subplot.
9595

9696
fig = pygmt.Figure()
9797
with fig.subplot(
@@ -111,9 +111,9 @@
111111

112112
###############################################################################
113113
# In this example, we define a 2-row, 2-column (2x2) subplot layout using
114-
# :meth:`pygmt.Figure.subplot`. The overall figure dimensions is set to be 15 cm
115-
# wide and 6 cm high (``figsize=["15c", "6c"]``). In addition, we use some
116-
# optional arguments to fine-tune some details of the figure creation:
114+
# :meth:`pygmt.Figure.subplot`. The overall figure dimensions is set to be
115+
# 15 cm wide and 6 cm high (``figsize=["15c", "6c"]``). In addition, we use
116+
# some optional parameters to fine-tune some details of the figure creation:
117117
#
118118
# - ``autolabel=True``: Each subplot is automatically labelled abcd
119119
# - ``margins=["0.1c", "0.2c"]``: adjusts the space between adjacent subplots.
@@ -146,7 +146,7 @@
146146
# .. note::
147147
#
148148
# All plotting functions (e.g. :meth:`pygmt.Figure.coast`,
149-
# :meth:`pygmt.Figure.text`, etc) are able to use ``panel`` argument when
149+
# :meth:`pygmt.Figure.text`, etc) are able to use ``panel`` parameter when
150150
# in subplot mode. Once a panel is activated using ``panel`` or
151151
# :meth:`pygmt.Figure.set_panel`, subsequent plotting commands that don't
152152
# set a ``panel`` will have their elements added to the same panel as
@@ -157,7 +157,7 @@
157157
# --------------------------
158158
# In the example above with the four subplots, the two subplots for each row
159159
# have the same Y-axis range, and the two subplots for each column have the
160-
# same X-axis range. You can use the ``sharex``/``sharey`` arguments to set a
160+
# same X-axis range. You can use the ``sharex``/``sharey`` parameters to set a
161161
# common X and/or Y axis between subplots.
162162

163163
fig = pygmt.Figure()

pygmt/src/subplot.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
4040
This function is used to split the current figure into a rectangular layout
4141
of subplots that each may contain a single self-contained figure. Begin by
4242
defining the layout of the entire multi-panel illustration. Several
43-
arguments are available to specify the systematic layout, labeling,
43+
parameters are available to specify the systematic layout, labeling,
4444
dimensions, and more for the subplots.
4545
4646
Full option list at :gmt-docs:`subplot.html#synopsis-begin-mode`
@@ -137,7 +137,7 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
137137
138138
- Labels and titles that depends on which row or column are specified
139139
as usual via a subplot's own ``frame`` setting.
140-
- Append **+w** to the ``figsize`` or ``subsize`` argument to draw
140+
- Append **+w** to the ``figsize`` or ``subsize`` parameter to draw
141141
horizontal and vertical lines between interior panels using selected
142142
pen [no lines].
143143
title : str

pygmt/tests/test_subplot.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def test_subplot_basic_frame():
3030
@check_figures_equal()
3131
def test_subplot_direct():
3232
"""
33-
Plot map elements to subplot directly using the panel argument.
33+
Plot map elements to subplot directly using the panel parameter.
3434
"""
3535
fig_ref, fig_test = Figure(), Figure()
3636
with fig_ref.subplot(nrows=2, ncols=1, Fs="3c/3c"):
@@ -91,7 +91,7 @@ def test_subplot_clearance_and_shared_xy_axis_layout():
9191

9292
def test_subplot_figsize_and_subsize_error():
9393
"""
94-
Check that an error is raised when both figsize and subsize arguments are
94+
Check that an error is raised when both figsize and subsize parameters are
9595
passed into subplot.
9696
"""
9797
fig = Figure()

0 commit comments

Comments
 (0)