Skip to content

remove 'nan-like' from isnan description #149

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 1 commit into from
Apr 27, 2023
Merged

remove 'nan-like' from isnan description #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions spec/API_specification/dataframe_api/dataframe_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,12 +578,14 @@ def isnull(self) -> DataFrame:
Notes
-----
Does *not* include NaN-like entries.
May optionally include 'NaT' values (if present in an implementation),
but note that the Standard makes no guarantees about them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've lost track of where the discussion is happening for this. At any rate, we included NaT in the other one originally because it does not propagate through comparisons, which seemed like a reasonable way to split these.

Also what about None?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's here #141

I think that would also count as 'missing' (so, isnull rather than isnan)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the discussion in gh-141 before merging this (or not).

"""
...

def isnan(self) -> DataFrame:
"""
Check for nan-like entries.
Check for nan entries.

Returns
-------
Expand All @@ -595,7 +597,8 @@ def isnan(self) -> DataFrame:

Notes
-----
Includes anything with NaN-like semantics, e.g. np.datetime64("NaT").
This only checks for 'NaN'.
Does *not* include 'missing' or 'null' entries.
In particular, does not check for `np.timedelta64('NaT')`.
"""
...