Skip to content

DOC: Fix divmod return values #31894

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 4 commits into from
Feb 12, 2020
Merged

DOC: Fix divmod return values #31894

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9b93cb
Docstring for divmod and rdivmod now correctly return a tuple of series
naterarmstrong Feb 11, 2020
47c5987
DOC GH31663 Series.divmod docs correctly return a tuple
naterarmstrong Feb 11, 2020
6cde753
DOC fix issue causing double newline
naterarmstrong Feb 11, 2020
efd99bb
DOC Updated tuple to 2-tuple for clarity
naterarmstrong Feb 11, 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
43 changes: 38 additions & 5 deletions pandas/core/ops/docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def _make_flex_doc(op_name, typ):
op_name=op_name,
equiv=equiv,
reverse=op_desc["reverse"],
series_returns=op_desc["series_returns"],
)
if op_desc["series_examples"]:
doc = doc_no_examples + op_desc["series_examples"]
Expand Down Expand Up @@ -233,82 +234,115 @@ def _make_flex_doc(op_name, typ):
dtype: float64
"""

_returns_series = """Series\n The result of the operation."""

_returns_tuple = """2-Tuple of Series\n The result of the operation."""

_op_descriptions: Dict[str, Dict[str, Optional[str]]] = {
# Arithmetic Operators
"add": {
"op": "+",
"desc": "Addition",
"reverse": "radd",
"series_examples": _add_example_SERIES,
"series_returns": _returns_series,
},
"sub": {
"op": "-",
"desc": "Subtraction",
"reverse": "rsub",
"series_examples": _sub_example_SERIES,
"series_returns": _returns_series,
},
"mul": {
"op": "*",
"desc": "Multiplication",
"reverse": "rmul",
"series_examples": _mul_example_SERIES,
"series_returns": _returns_series,
"df_examples": None,
},
"mod": {
"op": "%",
"desc": "Modulo",
"reverse": "rmod",
"series_examples": _mod_example_SERIES,
"series_returns": _returns_series,
},
"pow": {
"op": "**",
"desc": "Exponential power",
"reverse": "rpow",
"series_examples": _pow_example_SERIES,
"series_returns": _returns_series,
"df_examples": None,
},
"truediv": {
"op": "/",
"desc": "Floating division",
"reverse": "rtruediv",
"series_examples": _div_example_SERIES,
"series_returns": _returns_series,
"df_examples": None,
},
"floordiv": {
"op": "//",
"desc": "Integer division",
"reverse": "rfloordiv",
"series_examples": _floordiv_example_SERIES,
"series_returns": _returns_series,
"df_examples": None,
},
"divmod": {
"op": "divmod",
"desc": "Integer division and modulo",
"reverse": "rdivmod",
"series_examples": None,
"series_returns": _returns_tuple,
"df_examples": None,
},
# Comparison Operators
"eq": {"op": "==", "desc": "Equal to", "reverse": None, "series_examples": None},
"eq": {
"op": "==",
"desc": "Equal to",
"reverse": None,
"series_examples": None,
"series_returns": _returns_series,
},
"ne": {
"op": "!=",
"desc": "Not equal to",
"reverse": None,
"series_examples": None,
"series_returns": _returns_series,
},
"lt": {
"op": "<",
"desc": "Less than",
"reverse": None,
"series_examples": None,
"series_returns": _returns_series,
},
"lt": {"op": "<", "desc": "Less than", "reverse": None, "series_examples": None},
"le": {
"op": "<=",
"desc": "Less than or equal to",
"reverse": None,
"series_examples": None,
"series_returns": _returns_series,
},
"gt": {
"op": ">",
"desc": "Greater than",
"reverse": None,
"series_examples": None,
"series_returns": _returns_series,
},
"gt": {"op": ">", "desc": "Greater than", "reverse": None, "series_examples": None},
"ge": {
"op": ">=",
"desc": "Greater than or equal to",
"reverse": None,
"series_examples": None,
"series_returns": _returns_series,
},
}

Expand Down Expand Up @@ -339,8 +373,7 @@ def _make_flex_doc(op_name, typ):

Returns
-------
Series
The result of the operation.
{series_returns}

See Also
--------
Expand Down