Improve docstings of OpenEphysBinaryRawIO
#1774
Merged
+409
−163
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.
While working on fixing a neuroconv issue, I noticed that the
OpenEphysBinaryRawIOclass lacks clear documentation about how the folder structure of the Open Ephys binary format is parsed and use internally.This PR improves the situation in two ways:
The docstring now more explicitly describes the type of structure being parsed and clarifies that
dirnamecan point to different levels within the folder tree, each yielding different parsing results.The current
explore_folderfunction mixes two responsibilities:To separate concerns, I split this logic into two private functions. Each now has a dedicated docstring that clearly explains its role. There is no change in implementation the function is just split in two.