Skip to content

DOC: Clarify output of diff (returned type and possible overflow) #32699

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
merged 36 commits into from
Jun 1, 2020
Merged

DOC: Clarify output of diff (returned type and possible overflow) #32699

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
3d63374
DOC: Note about dtypes in diff in Dataframe
mproszewska Mar 14, 2020
a53df3a
DOC: Note about dtypes in diff in Series
mproszewska Mar 14, 2020
c1d875a
DOC: Change comment
mproszewska Mar 21, 2020
2e8ccd0
DOC: Fix spaces
mproszewska Mar 21, 2020
50d55ee
DOC: Add doc decorator and overflow examples
mproszewska Mar 27, 2020
3efba72
DOC: Remove appender
mproszewska Apr 3, 2020
b7dd328
DOC: fix
mproszewska Apr 3, 2020
7fc66b9
DOC: fix
mproszewska Apr 3, 2020
8d53336
DOC: Fix
mproszewska Apr 3, 2020
ecf74e5
DOC: Fix strings
mproszewska Apr 9, 2020
74fe0e4
DOC: Fix
mproszewska Apr 9, 2020
3accc51
DOC: Fix
mproszewska Apr 9, 2020
45558c0
DOC: Fix
mproszewska Apr 9, 2020
df4e7d1
DOC: Add newlines
mproszewska Apr 9, 2020
16451c0
Merge branch 'master' into doc
mproszewska Apr 9, 2020
c9cd6c7
DOC: Fix newline
mproszewska Apr 9, 2020
ee062bc
DOC: Add dedent
mproszewska Apr 9, 2020
0f18905
DOC: Lint
mproszewska Apr 16, 2020
e799453
DOC: Lint
mproszewska Apr 16, 2020
b36b310
Run tests
mproszewska Apr 24, 2020
b92f42b
Change test_diff
mproszewska Apr 24, 2020
f03d4e9
Change stacklevel
mproszewska May 4, 2020
4a5b36f
Fix lint
mproszewska May 5, 2020
08fe128
Update algorithms.py
mproszewska May 5, 2020
5859ea6
Merge branch 'doc' of https://github.com/mproszewska/pandas into doc
mproszewska May 5, 2020
c94b45e
PERF: Remove unnecessary copies in sorting functions
mproszewska May 15, 2020
0ab450b
Run tests
mproszewska May 16, 2020
54c7304
Run tests
mproszewska May 16, 2020
6d72a34
Add asv
mproszewska May 22, 2020
5ba54a6
Run black
mproszewska May 22, 2020
2766270
Remove asv
mproszewska May 22, 2020
91176ca
Merge branch 'perf'
mproszewska May 24, 2020
a53d937
Add requested change
mproszewska May 28, 2020
b46a77d
Merge branch 'master' into doc
mproszewska May 28, 2020
949bcc0
Fix stacklevel
mproszewska May 28, 2020
234689d
Revert change
mproszewska May 31, 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
2 changes: 2 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6476,6 +6476,8 @@ def diff(self, periods=1, axis=0) -> "DataFrame":
-----
For boolean dtypes, this uses :meth:`operator.xor` rather than
:meth:`operator.sub`.
The result is calculated according to current dtype in DataFrame,
however dtype of the result is always float64.

Examples
--------
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2268,6 +2268,8 @@ def diff(self, periods=1) -> "Series":
-----
For boolean dtypes, this uses :meth:`operator.xor` rather than
:meth:`operator.sub`.
The result is calculated according to current dtype in Series,
however dtype of the result is always float64.

Examples
--------
Expand Down