Skip to content

Commit b7ca239

Browse files
committed
Move TODO comment to the top
1 parent 312aa39 commit b7ca239

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
@@ -1765,6 +1765,7 @@ def virtualfile_from_stringio(
17651765
seg.header = None
17661766
seg.text = None
17671767

1768+
# TODO(PyGMT>=0.20.0): Remove the deprecated parameter 'required_z'.
17681769
def virtualfile_in( # noqa: PLR0912
17691770
self,
17701771
check_kind=None,
@@ -1836,12 +1837,11 @@ def virtualfile_in( # noqa: PLR0912
18361837
... print(fout.read().strip())
18371838
<vector memory>: N = 3 <7/9> <4/6> <1/3>
18381839
"""
1839-
# TODO(PyGMT>=0.20.0): Remove the deprecated 'required_z' parameter.
18401840
if required_z is True:
18411841
warnings.warn(
1842-
"The parameter 'required_z' is deprecated and will be removed in "
1843-
"v0.20.0. Use parameter 'ncols' instead. E.g., ``required_z=True`` is "
1844-
"equivalent to ``ncols=3``.",
1842+
"The parameter 'required_z' is deprecated in v0.16.0 and will be "
1843+
"removed in v0.20.0. Use parameter 'ncols' instead. E.g., "
1844+
"``required_z=True`` is equivalent to ``ncols=3``.",
18451845
category=FutureWarning,
18461846
stacklevel=1,
18471847
)

0 commit comments

Comments
 (0)