typo sweep

Author: TomDonoghue

fooof/analysis/error.py

@@ -102,7 +102,7 @@ def compute_pointwise_error_fg(fg, plot_errors=True, return_errors=False, **plt_
 
 
 def compute_pointwise_error(model, data):
-    """Calculate pointwise error between original data and a model fit of that data.
+    """Calculate point-wise error between original data and a model fit of that data.
 
     Parameters
     ----------

fooof/bands/bands.py

@@ -1,4 +1,4 @@
-"""A data oject for managing band definitions."""
+"""A data object for managing band definitions."""
 
 from collections import OrderedDict
 
@@ -60,7 +60,7 @@ def __len__(self):
         return self.n_bands
 
     def __iter__(self):
-        """Define iteratation as stepping across each band."""
+        """Define iteration as stepping across each band."""
 
         for label, band_definition in self.bands.items():
             yield (label, band_definition)

fooof/core/info.py

@@ -70,7 +70,7 @@ def get_ap_indices(aperiodic_mode):
     Returns
     -------
     indices : dict
-        Mapping of the column labels and indices for the aperiodc parameters.
+        Mapping of the column labels and indices for the aperiodic parameters.
     """
 
     if aperiodic_mode == 'fixed':

fooof/core/io.py

@@ -198,7 +198,7 @@ def load_json(file_name, file_path):
 
 
 def load_jsonlines(file_name, file_path):
-    """Load a jsonlines file, yielding data line by line.
+    """Load a json-lines file, yielding data line by line.
 
     Parameters
     ----------

fooof/core/modutils.py

@@ -79,7 +79,7 @@ def docs_append_to_section(docstring, section, add):
 
     Parameters
     ----------
-    ds : str
+    docstring : str
         Docstring to update.
     section : str
         Name of the section within the docstring to add to.

fooof/core/reports.py

@@ -16,6 +16,7 @@
 REPORT_FONT = {'family': 'monospace',
                'weight': 'normal',
                'size': 16}
+SAVE_FORMAT = 'pdf'
 
 ###################################################################################################
 ###################################################################################################
@@ -61,7 +62,7 @@ def save_report_fm(fm, file_name, file_path=None, plt_log=False):
     ax2.set_yticks([])
 
     # Save out the report
-    plt.savefig(fpath(file_path, fname(file_name, 'pdf')))
+    plt.savefig(fpath(file_path, fname(file_name, SAVE_FORMAT)))
     plt.close()
 
 
@@ -104,5 +105,5 @@ def save_report_fg(fg, file_name, file_path=None):
     plot_fg_peak_cens(fg, ax3)
 
     # Save out the report
-    plt.savefig(fpath(file_path, fname(file_name, 'pdf')))
+    plt.savefig(fpath(file_path, fname(file_name, SAVE_FORMAT)))
     plt.close()

fooof/core/utils.py

@@ -210,7 +210,7 @@ def check_inds(inds):
     This function works only on indices defined for 1 dimension.
     """
 
-    # Typcasting: if a single int, convert to an array
+    # Typecasting: if a single int, convert to an array
     if isinstance(inds, int):
         inds = np.array([inds])
     # Typecasting: if a list or range, convert to an array

fooof/objs/fit.py

@@ -305,7 +305,7 @@ def add_data(self, freqs, power_spectrum, freq_range=None, clear_results=True):
         """
 
         # If any data is already present, then clear previous data
-        # Also clear results, is results are present, unless indicated not to
+        # Also clear results, if present, unless indicated not to
         #   This is to ensure object consistency of all data & results
         self._reset_data_results(clear_freqs=self.has_data,
                                  clear_spectrum=self.has_data,
@@ -860,7 +860,7 @@ def _fit_peaks(self, flat_iter):
                 guess_std = compute_gauss_std(fwhm)
 
             except ValueError:
-                # This procedure can fail (extremely rarely), if both le & ri ind's end up as None
+                # This procedure can fail (very rarely), if both left & right inds end up as None
                 #   In this case, default the guess to the average of the peak width limits
                 guess_std = np.mean(self.peak_width_limits)
 
@@ -1036,21 +1036,21 @@ def _drop_peak_overlap(self, guess):
         Notes
         -----
         For any gaussians with an overlap that crosses the threshold,
-        the lowest height guess guassian is dropped.
+        the lowest height guess Gaussian is dropped.
         """
 
-        # Sort the peak guesses by increasing frequency, so adjacenent peaks can
-        #   be compared from right to left.
+        # Sort the peak guesses by increasing frequency
+        #   This is so adjacent peaks can be compared from right to left
         guess = sorted(guess, key=lambda x: float(x[0]))
 
         # Calculate standard deviation bounds for checking amount of overlap
-        #   The bounds are the gaussian frequncy +/- gaussian standard deviation
+        #   The bounds are the gaussian frequency +/- gaussian standard deviation
         bounds = [[peak[0] - peak[2] * self._gauss_overlap_thresh,
                    peak[0] + peak[2] * self._gauss_overlap_thresh] for peak in guess]
 
         # Loop through peak bounds, comparing current bound to that of next peak
         #   If the left peak's upper bound extends pass the right peaks lower bound,
-        #   Then drop the guassian with the lower height.
+        #   then drop the Gaussian with the lower height
         drop_inds = []
         for ind, b_0 in enumerate(bounds[:-1]):
             b_1 = bounds[ind + 1]

fooof/objs/group.py

@@ -557,7 +557,7 @@ def _check_width_limits(self):
         """Check and warn about bandwidth limits / frequency resolution interaction."""
 
         # Only check & warn on first power spectrum
-        #   This is to avoid spamming stdout for every spectrum in the group
+        #   This is to avoid spamming standard output for every spectrum in the group
         if self.power_spectra[0, 0] == self.power_spectrum[0]:
             super()._check_width_limits()
 

fooof/objs/utils.py

@@ -138,7 +138,7 @@ def combine_fooofs(fooofs):
     --------
     Combine FOOOF objects together (where `fm1`, `fm2` & `fm3` are assumed to be defined and fit):
 
-    >>> fg = combine_fooofs([fm1, fm2, f3])  # doctest:+SKIP
+    >>> fg = combine_fooofs([fm1, fm2, fm3])  # doctest:+SKIP
 
     Combine FOOOFGroup objects together (where `fg1` & `fg2` are assumed to be defined and fit):