Skip to content

Commit

Permalink
DOC: Change doc template to fix SA04 errors in docstrings #28792 (#32972
Browse files Browse the repository at this point in the history
)
  • Loading branch information
dilex42 authored Apr 10, 2020
1 parent 7f276c8 commit 12ffb23
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions pandas/core/ops/docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,14 @@ def _make_flex_doc(op_name, typ):

if typ == "series":
base_doc = _flex_doc_SERIES
if op_desc["reverse"]:
base_doc += _see_also_reverse_SERIES.format(
reverse=op_desc["reverse"], see_also_desc=op_desc["see_also_desc"],
)
doc_no_examples = base_doc.format(
desc=op_desc["desc"],
op_name=op_name,
equiv=equiv,
reverse=op_desc["reverse"],
series_returns=op_desc["series_returns"],
)
if op_desc["series_examples"]:
Expand Down Expand Up @@ -375,12 +378,22 @@ def _make_flex_doc(op_name, typ):
},
}

_py_num_ref = """see
`Python documentation
<https://docs.python.org/3/reference/datamodel.html#emulating-numeric-types>`_
for more details"""
_op_names = list(_op_descriptions.keys())
for key in _op_names:
reverse_op = _op_descriptions[key]["reverse"]
if reverse_op is not None:
_op_descriptions[reverse_op] = _op_descriptions[key].copy()
_op_descriptions[reverse_op]["reverse"] = key
_op_descriptions[key][
"see_also_desc"
] = f"Reverse of the {_op_descriptions[key]['desc']} operator, {_py_num_ref}"
_op_descriptions[reverse_op][
"see_also_desc"
] = f"Element-wise {_op_descriptions[key]['desc']}, {_py_num_ref}"

_flex_doc_SERIES = """
Return {desc} of series and other, element-wise (binary operator `{op_name}`).
Expand All @@ -403,10 +416,12 @@ def _make_flex_doc(op_name, typ):
Returns
-------
{series_returns}
"""

_see_also_reverse_SERIES = """
See Also
--------
Series.{reverse}
Series.{reverse} : {see_also_desc}.
"""

_arith_doc_FRAME = """
Expand Down

0 comments on commit 12ffb23

Please sign in to comment.