DOC: Clarify read_raw_nirx expects directory path, not file path #13541
+10
−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
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
natinew77-creator
requested review from
agramfort,
dengemann,
drammock and
rob-luke
as code owners
larsoner
reviewed
Dec 19, 2025
mne/io/nirx/nirx.py
Outdated
| ) -> "RawNIRX": | ||
| """Reader for a NIRX fNIRS recording. | ||
| .. note:: |
Member
There was a problem hiding this comment.
This should probably go in the Notes section (new one if needed) rather than adding a big note at the top
| version 15.0 and above and Aurora version 2021 and above. | ||
| MNE-Python supports reading data from NIRScout and NIRSport devices. | ||
| .. important:: |
Member
There was a problem hiding this comment.
I'm not sure we need to go into this detail in an example... the docstring update should be good enough
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.
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 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.Addresses #13353
Changes
mne/io/nirx/nirx.pyread_raw_nirxdocstring explaining the directory requirementread_raw_snirffor.snirffilestutorials/io/30_reading_fnirs_data.pyTesting
Documentation-only change. No new tests required.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:
Fixes #13353
Reference issue (if any)
What does this implement/fix?
Additional information