Skip to content

Commit

Permalink
[test-upstream] Use parameter instead of argument when describing fun…
Browse files Browse the repository at this point in the history
…ction signature
  • Loading branch information
spencerkclark committed Jan 29, 2023
1 parent c82a2c1 commit 7a291c6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions doc/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Breaking changes

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

Expand Down
16 changes: 8 additions & 8 deletions xarray/coding/cftime_offsets.py
Original file line number Diff line number Diff line change
Expand Up @@ -875,8 +875,8 @@ def __repr__(self) -> str:
def _translate_closed_to_inclusive(closed):
"""Follows code added in pandas #43504."""
emit_user_level_warning(
"Following pandas, the `closed` argument is deprecated in "
"favor of the `inclusive` argument, and will be removed in "
"Following pandas, the `closed` parameter is deprecated in "
"favor of the `inclusive` parameter, and will be removed in "
"a future version of xarray.",
FutureWarning,
)
Expand Down Expand Up @@ -933,14 +933,14 @@ def cftime_range(
Normalize start/end dates to midnight before generating date range.
name : str, default: None
Name of the resulting index
closed : {"left", "right"} or None, default: _NoDefault
closed : {"left", "right"} or None, default: "no_default"
Make the interval closed with respect to the given frequency to the
"left", "right", or both sides (None).
.. deprecated:: 2023.01.1
Following pandas, the ``closed`` argument is deprecated in favor
of the ``inclusive`` argument, and will be removed in a future
Following pandas, the ``closed`` parameter is deprecated in favor
of the ``inclusive`` parameter, and will be removed in a future
version of xarray.
inclusive : {None, "both", "neither", "left", "right"}, default None
Expand Down Expand Up @@ -1180,13 +1180,13 @@ def date_range(
Normalize start/end dates to midnight before generating date range.
name : str, default: None
Name of the resulting index
closed : {"left", "right"} or None, default: _NoDefault
closed : {"left", "right"} or None, default: "no_default"
Make the interval closed with respect to the given frequency to the
"left", "right", or both sides (None).
.. deprecated:: 2023.01.1
Following pandas, the `closed` argument is deprecated in favor
of the `inclusive` argument, and will be removed in a future
Following pandas, the `closed` parameter is deprecated in favor
of the `inclusive` parameter, and will be removed in a future
version of xarray.
inclusive : {None, "both", "neither", "left", "right"}, default None
Include boundaries; whether to set each bound as closed or open.
Expand Down

0 comments on commit 7a291c6

Please sign in to comment.