Skip to content

Commit 330e324

Browse files
committed
fix docstr and whats_new
1 parent 4413193 commit 330e324

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

docs/whats_new.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Current
3232

3333
Changelog
3434
~~~~~~~~~
35-
- It's now possible to pass kwargs arguments to the notch filter inside prep; see the ``filter_kwargs`` parameter by `Yorguin Mantilla`_ (`#40 <https://github.com/sappelhoff/pyprep/pull/40>`_)
35+
- It's now possible to pass keyword arguments to the notch filter inside prep; see the ``filter_kwargs`` parameter by `Yorguin Mantilla`_ (`#40 <https://github.com/sappelhoff/pyprep/pull/40>`_)
3636
- The default filter length for the spectrum_fit method will be '10s' to fix memory issues, by `Yorguin Mantilla`_ (`#40 <https://github.com/sappelhoff/pyprep/pull/40>`_)
3737
- Channel types are now available from a new ``ch_types_all`` attribute, and non-EEG channel names are now available from a new ``ch_names_non_eeg`` attribute from :class:`pyprep.PrepPipeline`, by `Yorguin Mantilla`_ (`#34 <https://github.com/sappelhoff/pyprep/pull/34>`_)
3838
- Renaming of ``ch_names`` attribute of ``PrepPipeline`` to ``ch_names_all``, by `Yorguin Mantilla`_ (`#34 <https://github.com/sappelhoff/pyprep/pull/34>`_)

pyprep/prep_pipeline.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,12 @@ class PrepPipeline:
4040
an int, it will be used as a seed for RandomState.
4141
If None, the seed will be obtained from the operating system
4242
(see RandomState for details). Default is None.
43-
filter_kwargs : dictionary
44-
Keywords arguments for the mne.filter.notch_filter function.
45-
Note Fs and freqs are already set up by the prep_params dictionary.
43+
filter_kwargs : dict | None
44+
Optional keywords arguments to be passed on to mne.filter.notch_filter.
45+
Do not set the "x", Fs", and "freqs" arguments via the filter_kwargs
46+
parameter, but use the "raw" and "prep_params" parameters instead.
47+
If None is passed, the pyprep default settings for filtering are used
48+
instead.
4649
4750
Attributes
4851
----------

0 commit comments

Comments
 (0)