DOC: Added series operation name/example to flex_doc

Author: James-Gilbert-

pandas/core/ops.py

@@ -486,6 +486,30 @@ def _get_op_name(op, special):
 e   NaN  -4.0   NaN
 """
 
+_mul_example_FRAME = """
+>>> 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
+"""
+
 _op_descriptions = {
     # Arithmetic Operators
     'add': {'op': '+',
@@ -499,7 +523,7 @@ def _get_op_name(op, special):
     'mul': {'op': '*',
             'desc': 'Multiplication',
             'reverse': 'rmul',
-            'df_examples': None},
+            'df_examples': _mul_example_FRAME},
     'mod': {'op': '%',
             'desc': 'Modulo',
             'reverse': 'rmod',
@@ -580,31 +604,12 @@ def _get_op_name(op, special):
 
 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.add(b, fill_value=0)
-a    2.0
-b    1.0
-c    1.0
-d    1.0
-e    NaN
-dtype: float64
+{df_examples}
 
 See also
 --------
 Series.{reverse}
+
 """
 
 _arith_doc_FRAME = """
@@ -690,7 +695,6 @@ def _get_op_name(op, special):
 Panel.{reverse}
 """
 
-
 _agg_doc_PANEL = """
 Wrapper method for {op_name}
 
@@ -732,7 +736,8 @@ def _make_flex_doc(op_name, typ):
     if typ == 'series':
         base_doc = _flex_doc_SERIES
         doc = base_doc.format(desc=op_desc['desc'], op_name=op_name,
-                              equiv=equiv, reverse=op_desc['reverse'])
+                              equiv=equiv, reverse=op_desc['reverse'],
+                              df_examples=op_desc['df_examples'])
     elif typ == 'dataframe':
         base_doc = _flex_doc_FRAME
         doc = base_doc.format(desc=op_desc['desc'], op_name=op_name,
@@ -1296,7 +1301,7 @@ def wrapper(left, right):
                             "{op}".format(typ=type(left).__name__, op=str_rep))
 
         elif (is_extension_array_dtype(left) or
-                (is_extension_array_dtype(right) and not is_scalar(right))):
+              (is_extension_array_dtype(right) and not is_scalar(right))):
             # GH#22378 disallow scalar to exclude e.g. "category", "Int64"
             return dispatch_to_extension_op(op, left, right)