Merge pull request #399 from European-XFEL/docs-fixes

Minor docs fixes

Author: JamesWrigley

docs/changelog.md

@@ -25,8 +25,8 @@ Added:
   supports `DataCollection` objects to reference a point in time
 - Pre-built packages will be available on PyPI for Python 3.10 - 3.13 from the
   next release, rather than only Python 3.10 (!377).
-- [Scan.group_data] method to make an xarray or pandas GroupBy object based on
-  scan steps (!379).
+- [Scan.group_data()][extra.components.Scan.group_data] method to make an xarray
+  or pandas GroupBy object based on scan steps (!379).
 - [fit_gaussian()][extra.utils.fit_gaussian] has a new `nans_on_failure`
   argument to allow returning NaN arrays when fitting fails (!385).
 - [fit_gaussian()][extra.utils.fit_gaussian] now supports

src/extra/components/scan.py

@@ -343,11 +343,15 @@ def split_by_steps(self, data):
     def group_data(self, data):
         """Group data labelled with train IDs by scan step.
 
-        data can be an xarray object with trainId coordinates, or a pandas
+        `data` can be an xarray object with trainId coordinates, or a pandas
         object with train IDs in the index. The train IDs can be one level in a
         MultiIndex, so long as the level is named trainId.
 
-        Returns a GroupBy object from the relevant library.
+        Returns a GroupBy object from the relevant library (e.g. a
+        [DataArrayGroupedBy][xarray.core.groupby.DataArrayGroupBy] for a
+        [DataArray][xarray.DataArray] input, or a
+        [`DataFrameGroupBy`/`SeriesGroupBy`](https://pandas.pydata.org/docs/reference/groupby.html)
+        for a [DataFrame][pandas.DataFrame] or [Series][pandas.Series] input).
         """
         train_ix = np.concatenate(self.positions_train_ids)
         scan_pos = np.concatenate([np.full(tids.shape, p) for (p, tids) in self.steps])

src/extra/gui/jupyter/spectrometer_calibration.py

@@ -189,7 +189,7 @@ class SpectrometerCalibration:
     widget.close_all()
     ```
 
-    # Widget interraction
+    # Widget interaction
     ## Tab 1: ROI selection
 
     - Click and drag vertically on the image to define rectangular ROIs.

src/extra/gui/widgets/peak_selection.py

@@ -639,12 +639,13 @@ def get_selected_peaks(self):
         Returns the selected peak positions for all ROIs.
 
         Returns:
-            list: A list of dictionaries, one for each ROI processed. Each dict contains:
-                  - 'roi_def': The original ROI definition dictionary.
-                  - 'roi_index': The original index of the ROI in the input list.
-                  - 'peaks': A list of selected peak pixel positions for this ROI,
-                             sorted by pixel value. Returns an empty list if no peaks
-                             were selected for that ROI.
+            (list): A list of dictionaries, one for each ROI processed. Each dict contains:
+
+              - 'roi_def': The original ROI definition dictionary.
+              - 'roi_index': The original index of the ROI in the input list.
+              - 'peaks': A list of selected peak pixel positions for this ROI,
+                         sorted by pixel value. Returns an empty list if no peaks
+                         were selected for that ROI.
         """
         results = []
         for roi_data in self.rois_data:

src/extra/recipes/cookiebox.py

@@ -1069,7 +1069,7 @@ def load_data(self, run: DataCollection, **extra_kwargs_adq: Dict[str, Any]) ->
 
         Args:
           run: The run to calibrate.
-          kwargs_adq: Keyword arguments for the `AdqRawChannel` object if one wishes to override settings.
+          extra_kwargs_adq: Keyword arguments for the `AdqRawChannel` object if one wishes to override settings.
 
         Returns: An xarray DataArray with the traces containing axes ('trainId', 'pulseIndex', 'sample', 'tof').
         """

src/extra/recipes/grating.py

@@ -88,8 +88,6 @@ def setup(self,
         Setup calibration.
 
         Args:
-          bkg_run: The background run.
-          run: The calibration run.
           grating_signal: Where to read the grating data from.
                    Example: `signal_run["SQS_EXP_GH2-2/CORR/RECEIVER:daqOutput", "data.adc"]`
           scan: Scan object identfying where to read the undulator energy from.