Skip to content

Commit

Permalink
modified the automatically generated docstring to include the return … (
Browse files Browse the repository at this point in the history
#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 <elizalde.borja@bcg.com>
  • Loading branch information
BorjaElizalde and Borja Elizalde committed Jul 11, 2024
1 parent ac13a09 commit 61e209e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 1 addition & 5 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
--format=actions \
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
-i "pandas.DataFrame.max RT03" \
-i "pandas.DataFrame.mean RT03" \
-i "pandas.DataFrame.median RT03" \
-i "pandas.DataFrame.min RT03" \
-i "pandas.DataFrame.plot PR02" \
-i "pandas.Grouper PR02" \
-i "pandas.MultiIndex.append PR07,SA01" \
Expand Down Expand Up @@ -166,7 +162,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.product RT03" \
-i "pandas.Series.reorder_levels RT03,SA01" \
-i "pandas.Series.sem PR01,RT03,SA01" \
-i "pandas.Series.skew RT03,SA01" \
-i "pandas.Series.skew SA01" \
-i "pandas.Series.sparse PR01,SA01" \
-i "pandas.Series.sparse.density SA01" \
-i "pandas.Series.sparse.fill_value SA01" \
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -11777,6 +11777,8 @@ def last_valid_index(self) -> Hashable:
Returns
-------
{name1} or scalar\
Value containing the calculation referenced in the description.\
{see_also}\
{examples}
"""
Expand Down

0 comments on commit 61e209e

Please sign in to comment.