Skip to content

Commit 9e1096e

Browse files
authored
DOC: Fix doc for first_valid_index (#55236)
* Fix doc for first_valid_index * Replace notes with examples * Add explicit prints
1 parent d9a2ad1 commit 9e1096e

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

pandas/core/generic.py

+41-5
Original file line numberDiff line numberDiff line change
@@ -12466,11 +12466,6 @@ def first_valid_index(self) -> Hashable | None:
1246612466
-------
1246712467
type of index
1246812468
12469-
Notes
12470-
-----
12471-
If all elements are non-NA/null, returns None.
12472-
Also returns None for empty {klass}.
12473-
1247412469
Examples
1247512470
--------
1247612471
For Series:
@@ -12481,6 +12476,22 @@ def first_valid_index(self) -> Hashable | None:
1248112476
>>> s.last_valid_index()
1248212477
2
1248312478
12479+
>>> s = pd.Series([None, None])
12480+
>>> print(s.first_valid_index())
12481+
None
12482+
>>> print(s.last_valid_index())
12483+
None
12484+
12485+
If all elements in Series are NA/null, returns None.
12486+
12487+
>>> s = pd.Series()
12488+
>>> print(s.first_valid_index())
12489+
None
12490+
>>> print(s.last_valid_index())
12491+
None
12492+
12493+
If Series is empty, returns None.
12494+
1248412495
For DataFrame:
1248512496
1248612497
>>> df = pd.DataFrame({{'A': [None, None, 2], 'B': [None, 3, 4]}})
@@ -12493,6 +12504,31 @@ def first_valid_index(self) -> Hashable | None:
1249312504
1
1249412505
>>> df.last_valid_index()
1249512506
2
12507+
12508+
>>> df = pd.DataFrame({{'A': [None, None, None], 'B': [None, None, None]}})
12509+
>>> df
12510+
A B
12511+
0 None None
12512+
1 None None
12513+
2 None None
12514+
>>> print(df.first_valid_index())
12515+
None
12516+
>>> print(df.last_valid_index())
12517+
None
12518+
12519+
If all elements in DataFrame are NA/null, returns None.
12520+
12521+
>>> df = pd.DataFrame()
12522+
>>> df
12523+
Empty DataFrame
12524+
Columns: []
12525+
Index: []
12526+
>>> print(df.first_valid_index())
12527+
None
12528+
>>> print(df.last_valid_index())
12529+
None
12530+
12531+
If DataFrame is empty, returns None.
1249612532
"""
1249712533
return self._find_valid_index(how="first")
1249812534

0 commit comments

Comments
 (0)