Skip to content

DOC: Fix Docstring validation for pandas.Series.floordiv and others #58725

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 4 commits into from
May 15, 2024
Merged

DOC: Fix Docstring validation for pandas.Series.floordiv and others #58725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc8b14e
added description for 'other' parameter
sam-baumann May 15, 2024
acd1aa7
remove fixed checks
sam-baumann May 15, 2024
2589759
removed more fixed checks
sam-baumann May 15, 2024
25cd51f
remove more fixed checks
sam-baumann May 15, 2024
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
23 changes: 6 additions & 17 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,33 +165,23 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.tz_convert PR01,PR02" \
-i "pandas.Series.dt.tz_localize PR01,PR02" \
-i "pandas.Series.dt.unit GL08" \
-i "pandas.Series.eq PR07,SA01" \
-i "pandas.Series.floordiv PR07" \
-i "pandas.Series.ge PR07,SA01" \
-i "pandas.Series.gt PR07,SA01" \
-i "pandas.Series.eq SA01" \
-i "pandas.Series.ge SA01" \
-i "pandas.Series.gt SA01" \
-i "pandas.Series.kurt RT03,SA01" \
-i "pandas.Series.kurtosis RT03,SA01" \
-i "pandas.Series.le PR07,SA01" \
-i "pandas.Series.le SA01" \
-i "pandas.Series.list.__getitem__ SA01" \
-i "pandas.Series.list.flatten SA01" \
-i "pandas.Series.list.len SA01" \
-i "pandas.Series.lt PR07,SA01" \
-i "pandas.Series.ne PR07,SA01" \
-i "pandas.Series.lt SA01" \
-i "pandas.Series.ne SA01" \
-i "pandas.Series.pad PR01,SA01" \
-i "pandas.Series.plot PR02,SA01" \
-i "pandas.Series.pop RT03,SA01" \
-i "pandas.Series.pow PR07" \
-i "pandas.Series.prod RT03" \
-i "pandas.Series.product RT03" \
-i "pandas.Series.radd PR07" \
-i "pandas.Series.rdiv PR07" \
-i "pandas.Series.reorder_levels RT03,SA01" \
-i "pandas.Series.rfloordiv PR07" \
-i "pandas.Series.rmod PR07" \
-i "pandas.Series.rmul PR07" \
-i "pandas.Series.rpow PR07" \
-i "pandas.Series.rsub PR07" \
-i "pandas.Series.rtruediv PR07" \
-i "pandas.Series.sem PR01,RT03,SA01" \
-i "pandas.Series.skew RT03,SA01" \
-i "pandas.Series.sparse PR01,SA01" \
Expand Down Expand Up @@ -231,7 +221,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.str.wrap RT03,SA01" \
-i "pandas.Series.str.zfill RT03" \
-i "pandas.Series.struct.dtypes SA01" \
-i "pandas.Series.sub PR07" \
-i "pandas.Series.sum RT03" \
-i "pandas.Series.swaplevel SA01" \
-i "pandas.Series.to_dict SA01" \
Expand Down
1 change: 1 addition & 0 deletions pandas/core/ops/docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@ def make_flex_doc(op_name: str, typ: str) -> str:
Parameters
----------
other : Series or scalar value
The second operand in this operation.
level : int or name
Broadcast across a level, matching Index values on the
passed MultiIndex level.
Expand Down
Loading