Skip to content

Commit 119d36e

Browse files
Deprecate runtimes to run_times
1 parent 026e28e commit 119d36e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

pygmt/src/x2sys_cross.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ def tempfile_from_dftrack(track, suffix):
6060

6161
@fmt_docstring
6262
@deprecate_parameter("trackvalues", "track_values", "v0.18.0", remove_version="v0.20.0")
63+
@deprecate_parameter("runtimes", "run_times", "v0.18.0", remove_version="v0.20.0")
6364
@use_alias(
6465
A="combitable",
65-
C="runtimes",
66+
C="run_times",
6667
D="override",
6768
I="interpolation",
6869
S="speed",
@@ -124,10 +125,10 @@ def x2sys_cross(
124125
The file *combitable* is created by :gmt-docs:`x2sys_get's -L option
125126
<supplements/x2sys/x2sys_get.html#l>`.
126127
127-
runtimes : bool or str
128+
run_times : bool or str
128129
Compute and append the processing run-time for each pair to the
129-
progress message (use ``runtimes=True``). Pass in a file name (e.g.
130-
``runtimes="file.txt"``) to save these run-times to file. The idea here
130+
progress message (use ``run_times=True``). Pass in a file name (e.g.
131+
``run_times="file.txt"``) to save these run-times to file. The idea here
131132
is to use the knowledge of run-times to split the main process in a
132133
number of sub-processes that can each be launched in a different
133134
processor of your multi-core machine. See the MATLAB function

0 commit comments

Comments
 (0)