Skip to content

Add note on diff's n differing from pandas #3822

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

Merged
dcherian merged 2 commits into from
Mar 5, 2020
Merged

Add note on diff's n differing from pandas #3822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c55f021
note that n != periods in diff docstring
max-sixty Mar 4, 2020
69e4bf5
better wording based on feedback
max-sixty Mar 4, 2020
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
6 changes: 6 additions & 0 deletions xarray/core/dataarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2692,6 +2692,12 @@ def diff(self, dim: Hashable, n: int = 1, label: Hashable = "upper") -> "DataArr
difference : same type as caller
The n-th order finite difference of this object.

.. note::

`n` matches numpy's behavior and is different from pandas' first
argument named `periods`.


Examples
--------
>>> arr = xr.DataArray([5, 5, 6, 6], [[1, 2, 3, 4]], ['x'])
Expand Down
5 changes: 5 additions & 0 deletions xarray/core/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4879,6 +4879,11 @@ def diff(self, dim, n=1, label="upper"):
difference : same type as caller
The n-th order finite difference of this object.

.. note::

`n` matches numpy's behavior and is different from pandas' first
argument named `periods`.

Examples
--------
>>> ds = xr.Dataset({'foo': ('x', [5, 5, 6, 6])})
Expand Down