add description to fit_scan_sequence

dschick · Dec 29, 2023 · 4b3eae0 · 4b3eae0
1 parent abfe62a
commit 4b3eae0
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pyEvalData/evaluation.py b/pyEvalData/evaluation.py
@@ -878,6 +878,9 @@ def fit_scan_sequence(self, scan_sequence, mod, pars, xgrid=[], yerr='std', xerr
                           offset_t0=False, plot_separate=False, show_single=False):
         """fit_scan_sequence
 
+        Evaluate, fit, and plot the results of a given scan sequence from the
+        source file.
+
         Args:
             scan_sequence (list[
                 list/tuple[list[int],