Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation examples for ch_types configuration option #745

Merged
merged 5 commits into from
Jun 26, 2023
Merged

Fix documentation examples for ch_types configuration option #745

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
35874b4
fix: issue #744, fixed documentation of ch_types parameter in _config.py
allermat Jun 26, 2023
9b311a0
fix: issue #744, added bug fix to docs
allermat Jun 26, 2023
8dd723b
TST: Ping
larsoner Jun 26, 2023
ea1d240
Update docs/source/v1.4.md.inc
larsoner Jun 26, 2023
fb39915
TST: Pinging
larsoner Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/v1.4.md.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@

- Fix bug when `mf_reference_run != runs[0]` (#742 by @larsoner)
- Fix bug with too many JSON files found during empty room matching (#743 by @allermat)
- Fix bug with outdated info on ch_types config option (#744 by @allermat)
larsoner marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 1 addition & 4 deletions mne_bids_pipeline/_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,6 @@
"""
The channel types to consider.

!!! info
Currently, MEG and EEG data cannot be processed together.

???+ example "Example"
```python
# Use EEG channels:
Expand All @@ -215,7 +212,7 @@
# Use magnetometer and gradiometer MEG channels:
ch_types = ['mag', 'grad']

# Currently does not work and will raise an error message:
# Use MEG and EEG channels:
ch_types = ['meg', 'eeg']
```
"""
Expand Down