Skip to content

Commit 6694b79

Browse files
authored
DOC: Fix Docstring validation for pandas.Series.floordiv and others (#58725)
* added description for 'other' parameter * remove fixed checks * removed more fixed checks * remove more fixed checks
1 parent cf49570 commit 6694b79

File tree

2 files changed

+7
-17
lines changed

2 files changed

+7
-17
lines changed

ci/code_checks.sh

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -165,33 +165,23 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
165165
-i "pandas.Series.dt.tz_convert PR01,PR02" \
166166
-i "pandas.Series.dt.tz_localize PR01,PR02" \
167167
-i "pandas.Series.dt.unit GL08" \
168-
-i "pandas.Series.eq PR07,SA01" \
169-
-i "pandas.Series.floordiv PR07" \
170-
-i "pandas.Series.ge PR07,SA01" \
171-
-i "pandas.Series.gt PR07,SA01" \
168+
-i "pandas.Series.eq SA01" \
169+
-i "pandas.Series.ge SA01" \
170+
-i "pandas.Series.gt SA01" \
172171
-i "pandas.Series.kurt RT03,SA01" \
173172
-i "pandas.Series.kurtosis RT03,SA01" \
174-
-i "pandas.Series.le PR07,SA01" \
173+
-i "pandas.Series.le SA01" \
175174
-i "pandas.Series.list.__getitem__ SA01" \
176175
-i "pandas.Series.list.flatten SA01" \
177176
-i "pandas.Series.list.len SA01" \
178-
-i "pandas.Series.lt PR07,SA01" \
179-
-i "pandas.Series.ne PR07,SA01" \
177+
-i "pandas.Series.lt SA01" \
178+
-i "pandas.Series.ne SA01" \
180179
-i "pandas.Series.pad PR01,SA01" \
181180
-i "pandas.Series.plot PR02,SA01" \
182181
-i "pandas.Series.pop RT03,SA01" \
183-
-i "pandas.Series.pow PR07" \
184182
-i "pandas.Series.prod RT03" \
185183
-i "pandas.Series.product RT03" \
186-
-i "pandas.Series.radd PR07" \
187-
-i "pandas.Series.rdiv PR07" \
188184
-i "pandas.Series.reorder_levels RT03,SA01" \
189-
-i "pandas.Series.rfloordiv PR07" \
190-
-i "pandas.Series.rmod PR07" \
191-
-i "pandas.Series.rmul PR07" \
192-
-i "pandas.Series.rpow PR07" \
193-
-i "pandas.Series.rsub PR07" \
194-
-i "pandas.Series.rtruediv PR07" \
195185
-i "pandas.Series.sem PR01,RT03,SA01" \
196186
-i "pandas.Series.skew RT03,SA01" \
197187
-i "pandas.Series.sparse PR01,SA01" \
@@ -231,7 +221,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
231221
-i "pandas.Series.str.wrap RT03,SA01" \
232222
-i "pandas.Series.str.zfill RT03" \
233223
-i "pandas.Series.struct.dtypes SA01" \
234-
-i "pandas.Series.sub PR07" \
235224
-i "pandas.Series.sum RT03" \
236225
-i "pandas.Series.swaplevel SA01" \
237226
-i "pandas.Series.to_dict SA01" \

pandas/core/ops/docstrings.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,7 @@ def make_flex_doc(op_name: str, typ: str) -> str:
436436
Parameters
437437
----------
438438
other : Series or scalar value
439+
The second operand in this operation.
439440
level : int or name
440441
Broadcast across a level, matching Index values on the
441442
passed MultiIndex level.

0 commit comments

Comments
 (0)