Skip to content

Commit 406cb39

Browse files
committed
Rename 'required_z' to 'required_ncols' in Session.virtualfile_in
1 parent 5d3d308 commit 406cb39

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

pygmt/clib/session.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1773,8 +1773,8 @@ def virtualfile_in(
17731773
y=None,
17741774
z=None,
17751775
extra_arrays=None,
1776-
required_z=False,
17771776
required_data=True,
1777+
required_ncols=2,
17781778
):
17791779
"""
17801780
Store any data inside a virtual file.
@@ -1797,11 +1797,11 @@ def virtualfile_in(
17971797
extra_arrays : list of 1-D arrays
17981798
Optional. A list of numpy arrays in addition to x, y, and z.
17991799
All of these arrays must be of the same size as the x/y/z arrays.
1800-
required_z : bool
1801-
State whether the 'z' column is required.
18021800
required_data : bool
18031801
Set to True when 'data' is required, or False when dealing with
18041802
optional virtual files. [Default is True].
1803+
required_ncols
1804+
Number of minimum required columns.
18051805
18061806
Returns
18071807
-------
@@ -1835,8 +1835,8 @@ def virtualfile_in(
18351835
x=x,
18361836
y=y,
18371837
z=z,
1838-
required_z=required_z,
18391838
required_data=required_data,
1839+
required_ncols=required_ncols,
18401840
kind=kind,
18411841
)
18421842

0 commit comments

Comments
 (0)