precommit

Author: cadenmyers13

src/diffpy/labpdfproc/functions.py

@@ -40,8 +40,8 @@ def __init__(
         self._get_grid_points()
 
     def _get_grid_points(self):
-        """Given a radius and a grid size, return a grid of points to uniformly
-        sample that circle."""
+        """Given a radius and a grid size, return a grid of points to
+        uniformly sample that circle."""
         xs = np.linspace(-self.radius, self.radius, self.npoints)
         ys = np.linspace(-self.radius, self.radius, self.npoints)
         self.grid = {
@@ -50,8 +50,8 @@ def _get_grid_points(self):
         self.total_points_in_grid = len(self.grid)
 
     def _get_entry_exit_coordinates(self, coordinate, angle):
-        """Get the coordinates where the beam enters and leaves the circle for
-        a given angle and grid point.
+        """Get the coordinates where the beam enters and leaves the
+        circle for a given angle and grid point.
 
         It is calculated in the following way:
         For the entry coordinate,
@@ -108,8 +108,9 @@ def _get_entry_exit_coordinates(self, coordinate, angle):
         return entry_point, exit_point
 
     def _get_path_length(self, grid_point, angle):
-        """Return the path length of a horizontal line entering the circle at
-        the same height to the grid point then exiting at angle.
+        """Return the path length of a horizontal line entering the
+        circle at the same height to the grid point then exiting at
+        angle.
 
         Parameters
         ----------
@@ -136,8 +137,8 @@ def _get_path_length(self, grid_point, angle):
         return total_distance, primary_distance, secondary_distance
 
     def set_distances_at_angle(self, angle):
-        """Given an angle, set the distances from the grid points to the entry
-        and exit coordinates.
+        """Given an angle, set the distances from the grid points to the
+        entry and exit coordinates.
 
         Parameters
         ----------
@@ -170,8 +171,8 @@ def set_muls_at_angle(self, angle):
 
 
 def _cve_brute_force(input_pattern, mud):
-    """Compute cve for the given mud on a global grid using the brute-force
-    method.
+    """Compute cve for the given mud on a global grid using the brute-
+    force method.
 
     Assume mu=mud/2, given that the same mu*D yields the same cve and
     D/2=1.
@@ -202,8 +203,8 @@ def _cve_brute_force(input_pattern, mud):
 
 
 def _cve_polynomial_interpolation(input_pattern, mud):
-    """Compute cve using polynomial interpolation method, default to brute-
-    force computation if mu*D is out of the range (0.5 to 7)."""
+    """Compute cve using polynomial interpolation method, default to
+    brute- force computation if mu*D is out of the range (0.5 to 7)."""
     if mud > 7 or mud < 0.5:
         warnings.warn(
             f"Input mu*D = {mud} is out of the acceptable range "
@@ -286,8 +287,8 @@ def compute_cve(
 
 
 def apply_corr(input_pattern, absorption_correction):
-    """Apply absorption correction to the given diffraction object with the
-    correction diffraction object.
+    """Apply absorption correction to the given diffraction object with
+    the correction diffraction object.
 
     Parameters
     ----------

src/diffpy/labpdfproc/tools.py

@@ -76,7 +76,8 @@ def set_output_directory(args):
 
 
 def _expand_user_input(args):
-    """Expand the list of inputs by adding files from file lists and wildcards.
+    """Expand the list of inputs by adding files from file lists and
+    wildcards.
 
     Parameters
     ----------
@@ -112,9 +113,9 @@ def _expand_user_input(args):
 
 
 def set_input_lists(args):
-    """Set input directory and files. It takes cli inputs, checks if they are
-    files or directories and creates a list of files to be processed which is
-    stored in the args Namespace.
+    """Set input directory and files. It takes cli inputs, checks if
+    they are files or directories and creates a list of files to be
+    processed which is stored in the args Namespace.
 
     Parameters
     ----------
@@ -293,8 +294,8 @@ def set_wavelength(args):
 
 
 def set_xtype(args):
-    """Set the xtype based on the given input arguments, raise an error if
-    xtype is not one of {*XQUANTITIES, }.
+    """Set the xtype based on the given input arguments, raise an error
+    if xtype is not one of {*XQUANTITIES, }.
 
     Parameters
     ----------
@@ -349,8 +350,8 @@ def _parse_theoretical_input(input_str):
 
 
 def _set_theoretical_mud_from_density(args):
-    """Theoretical estimation of mu*D from sample composition, energy, and
-    sample mass density."""
+    """Theoretical estimation of mu*D from sample composition, energy,
+    and sample mass density."""
     args = normalize_wavelength(args)
     if args.wavelength is None:
         args = load_wavelength_from_config_file(args)
@@ -368,8 +369,8 @@ def _set_theoretical_mud_from_density(args):
 
 
 def _set_theoretical_mud_from_packing(args):
-    """Theoretical estimation of mu*D from sample composition, energy, and
-    packing fraction."""
+    """Theoretical estimation of mu*D from sample composition, energy,
+    and packing fraction."""
     sample_composition, energy, packing_fraction = _parse_theoretical_input(
         args.theoretical_from_packing
     )
@@ -424,8 +425,8 @@ def _load_key_value_pair(s):
 
 
 def load_user_metadata(args):
-    """Load user metadata into args, raise ValueError if it is in incorrect
-    format.
+    """Load user metadata into args, raise ValueError if it is in
+    incorrect format.
 
     Parameters
     ----------
@@ -465,8 +466,9 @@ def load_user_metadata(args):
 
 def load_user_info(args):
     """Load user info into args. If none is provided, call
-    check_and_build_global_config function from diffpy.utils to prompt the user
-    for inputs. Otherwise, call get_user_info with the provided arguments.
+    check_and_build_global_config function from diffpy.utils to prompt
+    the user for inputs. Otherwise, call get_user_info with the provided
+    arguments.
 
     Parameters
     ----------
@@ -513,9 +515,9 @@ def load_package_info(args):
 
 
 def preprocessing_args(args):
-    """Perform preprocessing on the provided args. The process includes loading
-    package and user information, setting input, output, wavelength, anode
-    type, xtype, mu*D, and loading user metadata.
+    """Perform preprocessing on the provided args. The process includes
+    loading package and user information, setting input, output,
+    wavelength, anode type, xtype, mu*D, and loading user metadata.
 
     Parameters
     ----------
@@ -541,8 +543,8 @@ def preprocessing_args(args):
 
 # Update load_metadata to use 'input_directory' consistently:
 def load_metadata(args, filepath):
-    """Load the relevant metadata from args to write into the header of the
-    output files.
+    """Load the relevant metadata from args to write into the header of
+    the output files.
 
     Parameters
     ----------