Skip to content

Commit

Permalink
DOC: Fix Docstring validation for pandas.Series.floordiv and others (#…
Browse files Browse the repository at this point in the history
…58725)

* added description for 'other' parameter

* remove fixed checks

* removed more fixed checks

* remove more fixed checks
  • Loading branch information
sam-baumann committed May 15, 2024
1 parent cf49570 commit 6694b79
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 17 deletions.
23 changes: 6 additions & 17 deletions ci/code_checks.sh
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
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

0 comments on commit 6694b79

Please sign in to comment.