diff --git a/doc/changes/dev/13543.doc.rst b/doc/changes/dev/13543.doc.rst new file mode 100644 index 00000000000..7543c7a02d7 --- /dev/null +++ b/doc/changes/dev/13543.doc.rst @@ -0,0 +1 @@ +Clarify that ``get_data()`` includes bad channels by default. \ No newline at end of file diff --git a/mne/utils/docs.py b/mne/utils/docs.py index 898fb9c34e1..26919dbc968 100644 --- a/mne/utils/docs.py +++ b/mne/utils/docs.py @@ -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}") +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}" )