Skip to content

DOC: Change doc template to fix SA04 errors in docstrings #28792 #32972

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 5 commits into from
Apr 10, 2020
Merged

DOC: Change doc template to fix SA04 errors in docstrings #28792 #32972

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
76096d3
DOC: Partial fix SA04 errors in docstrings #28792
dilex42 Mar 24, 2020
620382e
black formatting
dilex42 Mar 24, 2020
aad8bdb
Merge remote-tracking branch 'upstream/master' into doc-template
dilex42 Mar 24, 2020
d964388
Merge remote-tracking branch 'upstream/master' into doc-template
Apr 2, 2020
091ea9e
Change template to fix SA errors
Apr 2, 2020
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
19 changes: 17 additions & 2 deletions pandas/core/ops/docstrings.py
View file
Open in desktop
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}.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, can you undo the rest of the changes, and just leave something generic like this?

Suggested change
Series.{reverse} : {see_also_desc}.
Series.{reverse} : Reverse of the operator, see `Python documentation <https://docs.python.org/3/reference/datamodel.html#emulating-numeric-types>__` for more details.

This fixes the docstring validation problem, adds useful information to the user, and keeps things simple.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There will still be a problem with comparision operators rendering Series.None. I really can't see a way to handle both algebraic and comparision operators with one template.

"""

_arith_doc_FRAME = """
Expand Down