Skip to content

Commit 12ffb23

Browse files
author
dilex42
authored
DOC: Change doc template to fix SA04 errors in docstrings #28792 (#32972)
1 parent 7f276c8 commit 12ffb23

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

pandas/core/ops/docstrings.py

+17-2
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,14 @@ def _make_flex_doc(op_name, typ):
2929

3030
if typ == "series":
3131
base_doc = _flex_doc_SERIES
32+
if op_desc["reverse"]:
33+
base_doc += _see_also_reverse_SERIES.format(
34+
reverse=op_desc["reverse"], see_also_desc=op_desc["see_also_desc"],
35+
)
3236
doc_no_examples = base_doc.format(
3337
desc=op_desc["desc"],
3438
op_name=op_name,
3539
equiv=equiv,
36-
reverse=op_desc["reverse"],
3740
series_returns=op_desc["series_returns"],
3841
)
3942
if op_desc["series_examples"]:
@@ -375,12 +378,22 @@ def _make_flex_doc(op_name, typ):
375378
},
376379
}
377380

381+
_py_num_ref = """see
382+
`Python documentation
383+
<https://docs.python.org/3/reference/datamodel.html#emulating-numeric-types>`_
384+
for more details"""
378385
_op_names = list(_op_descriptions.keys())
379386
for key in _op_names:
380387
reverse_op = _op_descriptions[key]["reverse"]
381388
if reverse_op is not None:
382389
_op_descriptions[reverse_op] = _op_descriptions[key].copy()
383390
_op_descriptions[reverse_op]["reverse"] = key
391+
_op_descriptions[key][
392+
"see_also_desc"
393+
] = f"Reverse of the {_op_descriptions[key]['desc']} operator, {_py_num_ref}"
394+
_op_descriptions[reverse_op][
395+
"see_also_desc"
396+
] = f"Element-wise {_op_descriptions[key]['desc']}, {_py_num_ref}"
384397

385398
_flex_doc_SERIES = """
386399
Return {desc} of series and other, element-wise (binary operator `{op_name}`).
@@ -403,10 +416,12 @@ def _make_flex_doc(op_name, typ):
403416
Returns
404417
-------
405418
{series_returns}
419+
"""
406420

421+
_see_also_reverse_SERIES = """
407422
See Also
408423
--------
409-
Series.{reverse}
424+
Series.{reverse} : {see_also_desc}.
410425
"""
411426

412427
_arith_doc_FRAME = """

0 commit comments

Comments
 (0)