Skip to content

Commit a366269

Browse files
committed
[test-upstream] Use parameter instead of argument when describing function signature
1 parent c82a2c1 commit a366269

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

doc/whats-new.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Breaking changes
4545

4646
Deprecations
4747
~~~~~~~~~~~~
48-
- Following pandas, the `closed` arguments of :py:func:`cftime_range` and
49-
:py:func:`date_range` are deprecated in favor of the `inclusive` arguments,
48+
- Following pandas, the `closed` parameters of :py:func:`cftime_range` and
49+
:py:func:`date_range` are deprecated in favor of the `inclusive` parameters,
5050
and will be removed in a future version of xarray (:issue:`6985`:,
5151
:pull:`7373`). By `Spencer Clark <https://github.com/spencerkclark>`_.
5252

xarray/coding/cftime_offsets.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -875,8 +875,8 @@ def __repr__(self) -> str:
875875
def _translate_closed_to_inclusive(closed):
876876
"""Follows code added in pandas #43504."""
877877
emit_user_level_warning(
878-
"Following pandas, the `closed` argument is deprecated in "
879-
"favor of the `inclusive` argument, and will be removed in "
878+
"Following pandas, the `closed` parameter is deprecated in "
879+
"favor of the `inclusive` parameter, and will be removed in "
880880
"a future version of xarray.",
881881
FutureWarning,
882882
)
@@ -933,14 +933,14 @@ def cftime_range(
933933
Normalize start/end dates to midnight before generating date range.
934934
name : str, default: None
935935
Name of the resulting index
936-
closed : {"left", "right"} or None, default: _NoDefault
936+
closed : {"left", "right"} or None, default: "NO_DEFAULT"
937937
Make the interval closed with respect to the given frequency to the
938938
"left", "right", or both sides (None).
939939
940940
.. deprecated:: 2023.01.1
941941
942-
Following pandas, the ``closed`` argument is deprecated in favor
943-
of the ``inclusive`` argument, and will be removed in a future
942+
Following pandas, the ``closed`` parameter is deprecated in favor
943+
of the ``inclusive`` parameter, and will be removed in a future
944944
version of xarray.
945945
946946
inclusive : {None, "both", "neither", "left", "right"}, default None
@@ -1180,13 +1180,13 @@ def date_range(
11801180
Normalize start/end dates to midnight before generating date range.
11811181
name : str, default: None
11821182
Name of the resulting index
1183-
closed : {"left", "right"} or None, default: _NoDefault
1183+
closed : {"left", "right"} or None, default: "NO_DEFAULT"
11841184
Make the interval closed with respect to the given frequency to the
11851185
"left", "right", or both sides (None).
11861186
11871187
.. deprecated:: 2023.01.1
1188-
Following pandas, the `closed` argument is deprecated in favor
1189-
of the `inclusive` argument, and will be removed in a future
1188+
Following pandas, the `closed` parameter is deprecated in favor
1189+
of the `inclusive` parameter, and will be removed in a future
11901190
version of xarray.
11911191
inclusive : {None, "both", "neither", "left", "right"}, default None
11921192
Include boundaries; whether to set each bound as closed or open.

0 commit comments

Comments
 (0)