Skip to content

Commit 7b109c6

Browse files
Doc: update nirx_notes to use .. note:: directive
Incorporated feedback to format the directory requirement as a proper admonition note.
1 parent 31de139 commit 7b109c6

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

mne/utils/docs.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2885,11 +2885,10 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
28852885
mathematical functions the default behaviour is to return the
28862886
saturated data.
28872887
2888-
This function expects a **directory path** containing all NIRx data
2889-
files (e.g., ``.hdr``, ``.wl1``, ``.wl2``, etc.), not a path to a
2890-
single file. Passing a file path (e.g., ``"data.nirs"``) will result
2891-
in an error. If you have a ``.snirf`` file, use
2892-
:func:`mne.io.read_raw_snirf` instead.
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.
28932892
"""
28942893

28952894
docdict["niter"] = """

0 commit comments

Comments
 (0)