Skip to content

DOC: Clarify that get_data includes bad channels by default #13543

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

Open
shruti423 wants to merge 8 commits into
base: main
Choose a base branch
from
+4 −1
Open

DOC: Clarify that get_data includes bad channels by default #13543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9ee0c96
DOC: Clarify that get_data includes bad channels by default
shruti423 Dec 14, 2025
2c3cbf4
DOC: Move picks warning to global docdict in docs.py
shruti423 Dec 14, 2025
5c91475
Fix docstring parameter errors in docs.py
shruti423 Dec 15, 2025
40a7c1e
DOC: Add bad channels clarification to picks_all
shruti423 Dec 17, 2025
c89b214
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 17, 2025
ef870a5
DOC: Fix missing space in picks_all
shruti423 Dec 20, 2025
ad7ff80
Merge branch 'main' into doc-get-data-bads
larsoner Dec 24, 2025
b0cc2cb
DOC: Add changelog entry
shruti423 Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/13543.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that ``get_data()`` includes bad channels by default.
4 changes: 3 additions & 1 deletion mne/utils/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3454,7 +3454,9 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
{_picks_desc} {_picks_int} {_picks_str}"""
picks_base_notypes = f"""picks : list of int | list of str | slice | None
{_picks_desc} {_picks_int} {_picks_str_notypes}"""
docdict["picks_all"] = _reflow_param_docstring(f"{picks_base} all channels. {reminder}")
Copy link
Member

@larsoner larsoner Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The old code had a space between the period and the {reminder}, yours does not. I suspect this will lead to something like "end of sentence.Nospace before next", but it's possible we had it wrong before and what you now have is correct. Can you check?

docdict["picks_all"] = _reflow_param_docstring(
f"{picks_base} all channels. Bad channels are included by default. {reminder}"
)
docdict["picks_all_data"] = _reflow_param_docstring(
f"{picks_base} all data channels. {reminder}"
)
Expand Down