Skip to content

Commit 61e209e

Browse files
BorjaElizaldeBorja Elizalde
and
Borja Elizalde
authored
modified the automatically generated docstring to include the return … (#59229)
* modified the automatically generated docstring to include the return type specification * removed Series.skew from the list as is no longer giving error --------- Co-authored-by: Borja Elizalde <[email protected]>
1 parent ac13a09 commit 61e209e

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

ci/code_checks.sh

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7070
--format=actions \
7171
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
7272
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
73-
-i "pandas.DataFrame.max RT03" \
74-
-i "pandas.DataFrame.mean RT03" \
75-
-i "pandas.DataFrame.median RT03" \
76-
-i "pandas.DataFrame.min RT03" \
7773
-i "pandas.DataFrame.plot PR02" \
7874
-i "pandas.Grouper PR02" \
7975
-i "pandas.MultiIndex.append PR07,SA01" \
@@ -166,7 +162,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
166162
-i "pandas.Series.product RT03" \
167163
-i "pandas.Series.reorder_levels RT03,SA01" \
168164
-i "pandas.Series.sem PR01,RT03,SA01" \
169-
-i "pandas.Series.skew RT03,SA01" \
165+
-i "pandas.Series.skew SA01" \
170166
-i "pandas.Series.sparse PR01,SA01" \
171167
-i "pandas.Series.sparse.density SA01" \
172168
-i "pandas.Series.sparse.fill_value SA01" \

pandas/core/generic.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11777,6 +11777,8 @@ def last_valid_index(self) -> Hashable:
1177711777
Returns
1177811778
-------
1177911779
{name1} or scalar\
11780+
11781+
Value containing the calculation referenced in the description.\
1178011782
{see_also}\
1178111783
{examples}
1178211784
"""

0 commit comments

Comments
 (0)