Skip to content

pygmt.x2sys_cross: Deprecate parameter combitable to combi_table (Will be removed in v0.20.0) #4293

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.

Sign up for GitHub

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

Draft
yvonnefroehlich wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −4
Draft

pygmt.x2sys_cross: Deprecate parameter combitable to combi_table (Will be removed in v0.20.0) #4293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions pygmt/src/x2sys_cross.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ def tempfile_from_dftrack(track, suffix):

@fmt_docstring
@deprecate_parameter("trackvalues", "track_values", "v0.18.0", remove_version="v0.20.0")
@deprecate_parameter("combitable", "combi_table", "v0.18.0", remove_version="v0.20.0")
@use_alias(
A="combitable",
A="combi_table",
C="runtimes",
D="override",
I="interpolation",
Expand Down Expand Up @@ -118,10 +119,10 @@ def x2sys_cross(
Specify the x2sys TAG which identifies the attributes of this data
type.

combitable : str
Only process the pair-combinations found in the file *combitable*
combi_table : str
Only process the pair-combinations found in the file *combi_table*
[Default process all possible combinations among the specified files].
The file *combitable* is created by :gmt-docs:`x2sys_get's -L option
The file *combi_table* is created by :gmt-docs:`x2sys_get's -L option
<supplements/x2sys/x2sys_get.html#l>`.

runtimes : bool or str
Expand Down