DOC: Clarify read_raw_nirx expects directory path, not file path #13541
+9
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
natinew77-creator
requested review from
agramfort,
dengemann,
drammock and
rob-luke
as code owners
larsoner
reviewed
Dec 19, 2025
natinew77-creator
force-pushed
the
doc/clarify-read-raw-nirx-directory-requirement
branch
from
7b109c6 to
a680ff4
Compare
natinew77-creator
requested review from
adam2392,
mscheltienne and
sappelhoff
as code owners
Closed
8 tasks
This improves the documentation for read_raw_nirx to prevent the common 'OSError: Need a directory for fname but found a file' error that users encounter when passing a single file path instead of a directory path. Changes: - Added a note in the read_raw_nirx docstring explaining the directory requirement and suggesting read_raw_snirf for .snirf files - Added an important note in the fNIRS tutorial with correct/incorrect examples and troubleshooting guidance Fixes mne-tools#13353
Address review comments from @larsoner: move directory clarification to Notes section in read_raw_nirx and remove redundant warning in tutorial.
This ensures the clarification appears in both read_raw_nirx and RawNIRX documentation while maintaining cleaner docstring code.
Incorporated feedback to format the directory requirement as a proper admonition note.
natinew77-creator
force-pushed
the
doc/clarify-read-raw-nirx-directory-requirement
branch
from
a680ff4 to
8cf299e
Compare
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation for read_raw_nirx to clarify that it expects a directory path (or header file path within that directory), addressing a common user error where single file paths cause an OSError.
Key changes:
- Enhanced the
fnameparameter description inread_raw_nirxto explicitly state it accepts a directory or.hdrfile path - Added a note in the shared docstring explaining the directory requirement and suggesting
read_raw_snirffor.snirffiles
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
mne/utils/docs.py |
Added a note to the nirx_notes docstring clarifying the directory requirement for fname and suggesting an alternative for .snirf files |
mne/io/nirx/nirx.py |
Updated the fname parameter description to explicitly explain it accepts a directory containing NIRX files or the .hdr header file within that folder |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the documentation for
read_raw_nirxto clarify that it expects a directory path (or a header file path within that directory), addressing common user confusion that can lead to an OSError.Addresses #13353
Changes
fnameparameter description inread_raw_nirxto explicitly mention directory paths or the.hdrheader file.mne/utils/docs.py.