style: Docstring text should be on the next line after opening """ and be followed immediately by the line with closing """.

Author: steveayers124

pandas/util/_depr_module.py

@@ -8,7 +8,8 @@
 
 
 class _DeprecatedModule:
-    """ Class for mocking deprecated modules.
+    """
+    Class for mocking deprecated modules.
 
     Parameters
     ----------

pandas/util/_doctools.py

@@ -6,7 +6,7 @@
 class TablePlotter:
     """
     Layout some DataFrames in vertical/horizontal layout for explanation.
-    Used in merging.rst
+    Used in merging.rst.
     """
 
     def __init__(self, cell_width=0.37, cell_height=0.25, font_size=7.5):
@@ -16,7 +16,7 @@ def __init__(self, cell_width=0.37, cell_height=0.25, font_size=7.5):
 
     def _shape(self, df):
         """
-        Calculate table chape considering index levels.
+        Calculate table shape considering index levels.
         """
 
         row, col = df.shape
@@ -96,7 +96,9 @@ def plot(self, left, right, labels=None, vertical=True):
         return fig
 
     def _conv(self, data):
-        """Convert each input to appropriate for table outplot"""
+        """
+        Convert each input to appropriate for table outplot.
+        """
         if isinstance(data, pd.Series):
             if data.name is None:
                 data = data.to_frame(name="")

pandas/util/_exceptions.py

@@ -3,7 +3,9 @@
 
 @contextlib.contextmanager
 def rewrite_exception(old_name, new_name):
-    """Rewrite the message of an exception."""
+    """
+    Rewrite the message of an exception.
+    """
     try:
         yield
     except Exception as e:

pandas/util/_validators.py

@@ -229,7 +229,9 @@ def validate_args_and_kwargs(fname, args, kwargs, max_fname_arg_count, compat_ar
 
 
 def validate_bool_kwarg(value, arg_name):
-    """ Ensures that argument passed in arg_name is of type bool. """
+    """
+    Ensures that argument passed in arg_name is of type bool.
+    """
     if not (is_bool(value) or value is None):
         raise ValueError(
             'For argument "{arg}" expected type bool, received '
@@ -239,7 +241,8 @@ def validate_bool_kwarg(value, arg_name):
 
 
 def validate_axis_style_args(data, args, kwargs, arg_name, method_name):
-    """Argument handler for mixed index, columns / axis functions
+    """
+    Argument handler for mixed index, columns / axis functions
 
     In an attempt to handle both `.method(index, columns)`, and
     `.method(arg, axis=.)`, we have to do some bad things to argument
@@ -335,7 +338,8 @@ def validate_axis_style_args(data, args, kwargs, arg_name, method_name):
 
 
 def validate_fillna_kwargs(value, method, validate_scalar_dict_value=True):
-    """Validate the keyword arguments to 'fillna'.
+    """
+    Validate the keyword arguments to 'fillna'.
 
     This checks that exactly one of 'value' and 'method' is specified.
     If 'method' is specified, this validates that it's a valid method.

pandas/util/testing.py

@@ -476,7 +476,8 @@ def close(fignum=None):
 
 @contextmanager
 def ensure_clean(filename=None, return_filelike=False):
-    """Gets a temporary path and agrees to remove on close.
+    """
+    Gets a temporary path and agrees to remove on close.
 
     Parameters
     ----------
@@ -566,7 +567,8 @@ def ensure_safe_environment_variables():
 
 
 def equalContents(arr1, arr2):
-    """Checks if the set of unique elements of arr1 and arr2 are equivalent.
+    """
+    Checks if the set of unique elements of arr1 and arr2 are equivalent.
     """
     return frozenset(arr1) == frozenset(arr2)
 
@@ -581,7 +583,8 @@ def assert_index_equal(
     check_categorical: bool = True,
     obj: str = "Index",
 ) -> None:
-    """Check that left and right Index are equal.
+    """
+    Check that left and right Index are equal.
 
     Parameters
     ----------
@@ -603,7 +606,7 @@ def assert_index_equal(
         Whether to compare internal Categorical exactly.
     obj : str, default 'Index'
         Specify object name being compared, internally used to show appropriate
-        assertion message
+        assertion message.
     """
     __tracebackhide__ = True
 
@@ -707,7 +710,9 @@ def _get_ilevel_values(index, level):
 
 
 def assert_class_equal(left, right, exact=True, obj="Input"):
-    """checks classes are equal."""
+    """
+    Checks classes are equal.
+    """
     __tracebackhide__ = True
 
     def repr_class(x):
@@ -734,7 +739,8 @@ def repr_class(x):
 
 
 def assert_attr_equal(attr, left, right, obj="Attributes"):
-    """checks attributes are equal. Both objects must have attribute.
+    """
+    Checks attributes are equal. Both objects must have attribute.
 
     Parameters
     ----------
@@ -801,7 +807,9 @@ def isiterable(obj):
 
 
 def assert_is_sorted(seq):
-    """Assert that the sequence is sorted."""
+    """
+    Assert that the sequence is sorted.
+    """
     if isinstance(seq, (Index, Series)):
         seq = seq.values
     # sorting does not change precisions
@@ -811,7 +819,8 @@ def assert_is_sorted(seq):
 def assert_categorical_equal(
     left, right, check_dtype=True, check_category_order=True, obj="Categorical"
 ):
-    """Test that Categoricals are equivalent.
+    """
+    Test that Categoricals are equivalent.
 
     Parameters
     ----------
@@ -856,7 +865,8 @@ def assert_categorical_equal(
 
 
 def assert_interval_array_equal(left, right, exact="equiv", obj="IntervalArray"):
-    """Test that two IntervalArrays are equivalent.
+    """
+    Test that two IntervalArrays are equivalent.
 
     Parameters
     ----------
@@ -919,11 +929,13 @@ def raise_assert_detail(obj, message, left, right, diff=None):
     elif is_categorical_dtype(right):
         right = repr(right)
 
-    msg = """{obj} are different
-
-{message}
-[left]:  {left}
-[right]: {right}""".format(
+    msg = """
+        {obj} are different
+        
+        {message}
+        [left]:  {left}
+        [right]: {right}
+        """.format(
         obj=obj, message=message, left=left, right=right
     )
 
@@ -942,7 +954,8 @@ def assert_numpy_array_equal(
     check_same=None,
     obj="numpy array",
 ):
-    """ Checks that 'np.ndarray' is equivalent
+    """
+    Checks that 'np.ndarray' is equivalent
 
     Parameters
     ----------
@@ -1019,7 +1032,8 @@ def _raise(left, right, err_msg):
 def assert_extension_array_equal(
     left, right, check_dtype=True, check_less_precise=False, check_exact=False
 ):
-    """Check that left and right ExtensionArrays are equal.
+    """
+    Check that left and right ExtensionArrays are equal.
 
     Parameters
     ----------
@@ -1082,7 +1096,8 @@ def assert_series_equal(
     check_categorical=True,
     obj="Series",
 ):
-    """Check that left and right Series are equal.
+    """
+    Check that left and right Series are equal.
 
     Parameters
     ----------