Skip to content

Commit 7b189e9

Browse files
DOC: Clarify read_raw_nirx expects directory path, not file path (mne-tools#13541)
1 parent 16c7542 commit 7b189e9

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

mne/io/nirx/nirx.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@ def read_raw_nirx(
4141
Parameters
4242
----------
4343
fname : path-like
44-
Path to the NIRX data folder or header file.
44+
Path to the NIRX data folder (directory containing NIRX files) or
45+
the ``.hdr`` header file within that folder. The function will
46+
automatically find and read all required NIRX files from the
47+
directory.
4548
%(saturated)s
4649
%(preload)s
4750
%(encoding_nirx)s

mne/utils/docs.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2884,6 +2884,11 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
28842884
called .nosatflags_wlX. As NaN values can cause unexpected behaviour with
28852885
mathematical functions the default behaviour is to return the
28862886
saturated data.
2887+
2888+
.. note::
2889+
This function expects ``fname`` to be a path to a directory containing the
2890+
NIRX data files (e.g., ``.hdr``, ``.wl1``, ``.wl2``, etc.). If you have a
2891+
``.snirf`` file, use :func:`mne.io.read_raw_snirf` instead.
28872892
"""
28882893

28892894
docdict["niter"] = """

0 commit comments

Comments
 (0)