From d9b93cb02617ba6fcc17ba60fdbbe9efa56a1157 Mon Sep 17 00:00:00 2001 From: Nate Armstrong Date: Tue, 11 Feb 2020 10:37:48 -0800 Subject: [PATCH 1/4] Docstring for divmod and rdivmod now correctly return a tuple of series --- pandas/core/ops/docstrings.py | 47 +++++++++++++++++++++++++++++++---- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/pandas/core/ops/docstrings.py b/pandas/core/ops/docstrings.py index e3db65f11a332..93b47d5900e88 100644 --- a/pandas/core/ops/docstrings.py +++ b/pandas/core/ops/docstrings.py @@ -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"] @@ -233,6 +234,14 @@ def _make_flex_doc(op_name, typ): dtype: float64 """ +_returns_series = """Series + The result of the operation. +""" + +_returns_tuple = """Tuple of Series + The result of the operation. +""" + _op_descriptions: Dict[str, Dict[str, Optional[str]]] = { # Arithmetic Operators "add": { @@ -240,18 +249,21 @@ def _make_flex_doc(op_name, typ): "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": { @@ -259,12 +271,14 @@ def _make_flex_doc(op_name, typ): "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": { @@ -272,6 +286,7 @@ def _make_flex_doc(op_name, typ): "desc": "Floating division", "reverse": "rtruediv", "series_examples": _div_example_SERIES, + "series_returns": _returns_series, "df_examples": None, }, "floordiv": { @@ -279,6 +294,7 @@ def _make_flex_doc(op_name, typ): "desc": "Integer division", "reverse": "rfloordiv", "series_examples": _floordiv_example_SERIES, + "series_returns": _returns_series, "df_examples": None, }, "divmod": { @@ -286,29 +302,51 @@ def _make_flex_doc(op_name, typ): "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, }, } @@ -339,8 +377,7 @@ def _make_flex_doc(op_name, typ): Returns ------- -Series - The result of the operation. +{series_returns} See Also -------- From 47c59877cdc20dbb7405b217daff0597b01bbff1 Mon Sep 17 00:00:00 2001 From: Nate Armstrong Date: Tue, 11 Feb 2020 11:17:20 -0800 Subject: [PATCH 2/4] DOC GH31663 Series.divmod docs correctly return a tuple --- pandas/core/ops/docstrings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/ops/docstrings.py b/pandas/core/ops/docstrings.py index 93b47d5900e88..60517f27ffb6d 100644 --- a/pandas/core/ops/docstrings.py +++ b/pandas/core/ops/docstrings.py @@ -310,7 +310,7 @@ def _make_flex_doc(op_name, typ): "op": "==", "desc": "Equal to", "reverse": None, - "series_examples": None + "series_examples": None, "series_returns": _returns_series, }, "ne": { From 6cde753d068aa1fd7d57ac8fb953e046e7bfb250 Mon Sep 17 00:00:00 2001 From: Nate Armstrong Date: Tue, 11 Feb 2020 11:56:38 -0800 Subject: [PATCH 3/4] DOC fix issue causing double newline --- pandas/core/ops/docstrings.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/pandas/core/ops/docstrings.py b/pandas/core/ops/docstrings.py index 60517f27ffb6d..60cadc977263e 100644 --- a/pandas/core/ops/docstrings.py +++ b/pandas/core/ops/docstrings.py @@ -234,13 +234,9 @@ def _make_flex_doc(op_name, typ): dtype: float64 """ -_returns_series = """Series - The result of the operation. -""" +_returns_series = """Series\n The result of the operation.""" -_returns_tuple = """Tuple of Series - The result of the operation. -""" +_returns_tuple = """Tuple of Series\n The result of the operation.""" _op_descriptions: Dict[str, Dict[str, Optional[str]]] = { # Arithmetic Operators From efd99bb1ceeea7f9552b6d77fceac0e9711be3be Mon Sep 17 00:00:00 2001 From: Nate Armstrong Date: Tue, 11 Feb 2020 15:53:35 -0800 Subject: [PATCH 4/4] DOC Updated tuple to 2-tuple for clarity --- pandas/core/ops/docstrings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/ops/docstrings.py b/pandas/core/ops/docstrings.py index 60cadc977263e..203ea3946d1b2 100644 --- a/pandas/core/ops/docstrings.py +++ b/pandas/core/ops/docstrings.py @@ -236,7 +236,7 @@ def _make_flex_doc(op_name, typ): _returns_series = """Series\n The result of the operation.""" -_returns_tuple = """Tuple of 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