DOC: clarify ref_chs vs reref_chs

sappelhoff · Oct 27, 2023 · 693d336 · 693d336
1 parent 4722903
commit 693d336
Showing 1 changed file with 5 additions and 2 deletions.
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