Skip to content

DOC: Clarify read_raw_nirx expects directory path, not file path #13541

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
natinew77-creator wants to merge 5 commits into
base: main
Choose a base branch
from
Open

DOC: Clarify read_raw_nirx expects directory path, not file path #13541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48b5755
DOC: Clarify read_raw_nirx expects directory path, not file path
natinew77-creator Dec 11, 2025
e5fc1df
Doc: proper placement of definition in nirx reader
natinew77-creator Dec 20, 2025
5441f9e
Doc: move nirx directory warning to centralized nirx_notes
natinew77-creator Dec 20, 2025
8cf299e
Doc: update nirx_notes to use .. note:: directive
natinew77-creator Dec 25, 2025
9f2f34b
Doc: fix NIRX capitalization in docstring
natinew77-creator Dec 25, 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
5 changes: 4 additions & 1 deletion mne/io/nirx/nirx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ def read_raw_nirx(
Parameters
----------
fname : path-like
Path to the NIRX data folder or header file.
Path to the NIRX data folder (directory containing NIRX files) or
the ``.hdr`` header file within that folder. The function will
automatically find and read all required NIRX files from the
directory.
%(saturated)s
%(preload)s
%(encoding_nirx)s
Expand Down
5 changes: 5 additions & 0 deletions mne/utils/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2884,6 +2884,11 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
called .nosatflags_wlX. As NaN values can cause unexpected behaviour with
mathematical functions the default behaviour is to return the
saturated data.

.. note::
This function expects ``fname`` to be a path to a directory containing the
NIRX data files (e.g., ``.hdr``, ``.wl1``, ``.wl2``, etc.). If you have a
``.snirf`` file, use :func:`mne.io.read_raw_snirf` instead.
"""

docdict["niter"] = """
Expand Down