From b9d293cbb8bbe84d25df4421b9a072e7fadc5f26 Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sun, 5 May 2024 11:36:24 +0530 Subject: [PATCH 1/4] DOC: add PR07 for pandas.Series.mul --- pandas/core/series.py | 66 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 36b9bd2c59dce..d1158bfb8785e 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -5973,7 +5973,6 @@ def rsub(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: other, roperator.rsub, level=level, fill_value=fill_value, axis=axis ) - @Appender(ops.make_flex_doc("mul", "series")) def mul( self, other, @@ -5981,6 +5980,71 @@ def mul( fill_value: float | None = None, axis: Axis = 0, ) -> Series: + """ + Return Multiplication of series and other, element-wise + (binary operator `mul`). + + Equivalent to ``series * other``, but with support to substitute + a fill_value for + missing data in either one of the inputs. + + Parameters + ---------- + other : Series or scalar value + With which to compute the multiplication. + level : int or name + Broadcast across a level, matching Index values on the + passed MultiIndex level. + fill_value : None or float value, default None (NaN) + Fill existing missing (NaN) values, and any new element needed for + successful Series alignment, with this value before computation. + If data in both corresponding Series locations is missing + the result of filling (at that location) will be missing. + axis : {0 or 'index'} + Unused. Parameter needed for compatibility with DataFrame. + + Returns + ------- + Series + The result of the operation. + + See Also + -------- + Series.rmul : Reverse of the Multiplication operator, see + `Python documentation + `_ + for more details. + + Examples + -------- + >>> a = pd.Series([1, 1, 1, np.nan], index=["a", "b", "c", "d"]) + >>> a + a 1.0 + b 1.0 + c 1.0 + d NaN + dtype: float64 + >>> b = pd.Series([1, np.nan, 1, np.nan], index=["a", "b", "d", "e"]) + >>> b + a 1.0 + b NaN + d 1.0 + e NaN + dtype: float64 + >>> a.multiply(b, fill_value=0) + a 1.0 + b 0.0 + c 0.0 + d 0.0 + e NaN + dtype: float64 + >>> a.mul(5, fill_value=0) + a 5.0 + b 5.0 + c 5.0 + d 0.0 + dtype: float64 + """ return self._flex_method( other, operator.mul, level=level, fill_value=fill_value, axis=axis ) From 7b2a7d987cecdbe26f7b77fa0b45368c37f1145d Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sun, 5 May 2024 11:36:59 +0530 Subject: [PATCH 2/4] DOC: remove PR07 for pandas.Series.mul --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index dbb799779c1c4..e587b03068c16 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -210,7 +210,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Series.min RT03" \ -i "pandas.Series.mod PR07" \ -i "pandas.Series.mode SA01" \ - -i "pandas.Series.mul PR07" \ -i "pandas.Series.ne PR07,SA01" \ -i "pandas.Series.pad PR01,SA01" \ -i "pandas.Series.plot PR02,SA01" \ From f9114e06b47654a4990414287aaf5271339078ad Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sun, 5 May 2024 12:55:53 +0530 Subject: [PATCH 3/4] DOC: fit summary in single line --- pandas/core/series.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index d1158bfb8785e..50584b1fe901a 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -5981,8 +5981,7 @@ def mul( axis: Axis = 0, ) -> Series: """ - Return Multiplication of series and other, element-wise - (binary operator `mul`). + Return Multiplication of series and other, element-wise (binary operator `mul`). Equivalent to ``series * other``, but with support to substitute a fill_value for From 5c8ca6df072d7513663f5f85cfa42af50aeb4256 Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sun, 5 May 2024 12:56:11 +0530 Subject: [PATCH 4/4] DOC: fit summary in single line --- pandas/core/series.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 50584b1fe901a..face5e68c7adf 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -5984,8 +5984,7 @@ def mul( Return Multiplication of series and other, element-wise (binary operator `mul`). Equivalent to ``series * other``, but with support to substitute - a fill_value for - missing data in either one of the inputs. + a fill_value for missing data in either one of the inputs. Parameters ----------