Skip to content

Commit

Permalink
fix docstr and whats_new
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Oct 10, 2020
1 parent 4413193 commit 330e324
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Current

Changelog
~~~~~~~~~
- 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>`_)
- 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>`_)
- 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>`_)
- 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>`_)
- Renaming of ``ch_names`` attribute of ``PrepPipeline`` to ``ch_names_all``, by `Yorguin Mantilla`_ (`#34 <https://github.com/sappelhoff/pyprep/pull/34>`_)
Expand Down
9 changes: 6 additions & 3 deletions pyprep/prep_pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,12 @@ class PrepPipeline:
an int, it will be used as a seed for RandomState.
If None, the seed will be obtained from the operating system
(see RandomState for details). Default is None.
filter_kwargs : dictionary
Keywords arguments for the mne.filter.notch_filter function.
Note Fs and freqs are already set up by the prep_params dictionary.
filter_kwargs : dict | None
Optional keywords arguments to be passed on to mne.filter.notch_filter.
Do not set the "x", Fs", and "freqs" arguments via the filter_kwargs
parameter, but use the "raw" and "prep_params" parameters instead.
If None is passed, the pyprep default settings for filtering are used
instead.
Attributes
----------
Expand Down

0 comments on commit 330e324

Please sign in to comment.