DOC: clarify ref_chs vs reref_chs (#137)

* DOC: clarify ref_chs vs reref_chs * add whatsnew
sappelhoff · Oct 27, 2023 · 3f46a0b · 3f46a0b
1 parent 4722903
commit 3f46a0b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -37,6 +37,7 @@ Current (unreleased)
 Changelog
 ~~~~~~~~~
 - Use MNE logger and ProgressBar instead of prints to display logging messages, by `Mathieu Scheltienne`_ (:gh:`112`).
+- Clarify the use of ``ref_chs`` and ``reref_chs`` for the ``prep_params`` dict in :class:`~pyprep.PrepPipeline`, by `Stefan Appelhoff`_ (:gh:`137`).
 
 Bug
 ~~~

diff --git a/pyprep/prep_pipeline.py b/pyprep/prep_pipeline.py
@@ -24,10 +24,13 @@ class PrepPipeline:
 
         - ref_chs : {list, 'eeg'}
             - A list of channel names to be used for rereferencing.
+              These channels will be used to construct the reference
+              signal.
               Can be a str 'eeg' to use all EEG channels.
         - reref_chs : {list, 'eeg'}
-            - A list of channel names to be used for line-noise removed,
-              and referenced. Can be a str 'eeg' to use all EEG channels.
+            - A list of channel names to define from which channels the
+              reference signal will be subtracted.
+              Can be a str 'eeg' to use all EEG channels.
         - line_freqs : {np.ndarray, list}
             - list of floats indicating frequencies to be removed.
               For example, for 60Hz you may specify