DOC: Added series operation name/example to flex_doc and made naming consistent

Author: James-Gilbert-

pandas/core/ops.py

@@ -211,6 +211,7 @@ def make_invalid_op(name):
     -------
     invalid_op : function
     """
+
     def invalid_op(self, other=None):
         raise TypeError("cannot perform {name} with this index type: "
                         "{typ}".format(name=name, typ=type(self).__name__))
@@ -486,7 +487,7 @@ def _get_op_name(op, special):
 e   NaN  -4.0   NaN
 """
 
-_mul_example_FRAME = """
+_mul_example_SERIES = """
 >>> a = pd.Series([1, 1, 1, np.nan], index=['a', 'b', 'c', 'd'])
 >>> a
 a    1.0
@@ -515,61 +516,75 @@ def _get_op_name(op, special):
     'add': {'op': '+',
             'desc': 'Addition',
             'reverse': 'radd',
-            'df_examples': _add_example_FRAME},
+            'df_examples': _add_example_FRAME,
+            'series_examples': None},
     'sub': {'op': '-',
             'desc': 'Subtraction',
             'reverse': 'rsub',
-            'df_examples': _sub_example_FRAME},
+            'df_examples': _sub_example_FRAME,
+            'series_examples': None},
     'mul': {'op': '*',
             'desc': 'Multiplication',
             'reverse': 'rmul',
-            'df_examples': _mul_example_FRAME},
+            'df_examples': None,
+            'series_examples': _mul_example_SERIES},
     'mod': {'op': '%',
             'desc': 'Modulo',
             'reverse': 'rmod',
-            'df_examples': _mod_example_FRAME},
+            'df_examples': _mod_example_FRAME,
+            'series_examples': None},
     'pow': {'op': '**',
             'desc': 'Exponential power',
             'reverse': 'rpow',
-            'df_examples': None},
+            'df_examples': None,
+            'series_examples': None},
     'truediv': {'op': '/',
                 'desc': 'Floating division',
                 'reverse': 'rtruediv',
-                'df_examples': None},
+                'df_examples': None,
+                'series_examples': None},
     'floordiv': {'op': '//',
                  'desc': 'Integer division',
                  'reverse': 'rfloordiv',
-                 'df_examples': None},
+                 'df_examples': None,
+                 'series_examples': None},
     'divmod': {'op': 'divmod',
                'desc': 'Integer division and modulo',
                'reverse': None,
-               'df_examples': None},
+               'df_examples': None,
+               'series_examples': None},
 
     # Comparison Operators
     'eq': {'op': '==',
            'desc': 'Equal to',
            'reverse': None,
-           'df_examples': None},
+           'df_examples': None,
+           'series_examples': None},
     'ne': {'op': '!=',
            'desc': 'Not equal to',
            'reverse': None,
-           'df_examples': None},
+           'df_examples': None,
+           'series_examples': None},
     'lt': {'op': '<',
            'desc': 'Less than',
            'reverse': None,
-           'df_examples': None},
+           'df_examples': None,
+           'series_examples': None},
     'le': {'op': '<=',
            'desc': 'Less than or equal to',
            'reverse': None,
-           'df_examples': None},
+           'df_examples': None,
+           'series_examples': None},
     'gt': {'op': '>',
            'desc': 'Greater than',
            'reverse': None,
-           'df_examples': None},
+           'df_examples': None,
+           'series_examples': None},
     'ge': {'op': '>=',
            'desc': 'Greater than or equal to',
            'reverse': None,
-           'df_examples': None}}
+           'df_examples': None,
+           'series_examples': None}}
 
 _op_names = list(_op_descriptions.keys())
 for key in _op_names:
@@ -604,7 +619,7 @@ def _get_op_name(op, special):
 
 Examples
 --------
-{df_examples}
+{series_examples}
 
 See also
 --------
@@ -737,7 +752,7 @@ def _make_flex_doc(op_name, typ):
         base_doc = _flex_doc_SERIES
         doc = base_doc.format(desc=op_desc['desc'], op_name=op_name,
                               equiv=equiv, reverse=op_desc['reverse'],
-                              df_examples=op_desc['df_examples'])
+                              series_examples=op_desc['series_examples'])
     elif typ == 'dataframe':
         base_doc = _flex_doc_FRAME
         doc = base_doc.format(desc=op_desc['desc'], op_name=op_name,
@@ -1091,6 +1106,7 @@ def add_special_arithmetic_methods(cls):
     _, _, arith_method, comp_method, bool_method = _get_method_wrappers(cls)
     new_methods = _create_methods(cls, arith_method, comp_method, bool_method,
                                   special=True)
+
     # inplace operators (I feel like these should get passed an `inplace=True`
     # or just be removed