Skip to content

Commit b876edb

Browse files
hoechenbergerlarsoner
authored andcommitted
Fix incorrect type hint in Neuralynx I/O module (#12236)
1 parent 6e93117 commit b876edb

4 files changed

Lines changed: 22 additions & 3 deletions

File tree

doc/api/reading_raw_data.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Reading raw data
4040
read_raw_nihon
4141
read_raw_fil
4242
read_raw_nsx
43+
read_raw_neuralynx
4344

4445
Base class:
4546

doc/changes/v1.6.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1+
.. _changes_1_6_1:
2+
3+
Version 1.6.1 (unreleased)
4+
--------------------------
5+
6+
- Fix bug with type hints in :func:`mne.io.read_raw_neuralynx` (:gh:`12236` by `Richard Höchenberger`_)
7+
18
.. _changes_1_6_0:
29

310
Version 1.6.0 (2023-11-20)
411
--------------------------
512

613
Enhancements
714
~~~~~~~~~~~~
8-
- Add support for Neuralynx data files with ``mne.io.read_raw_neuralynx`` (:gh:`11969` by :newcontrib:`Kristijan Armeni` and :newcontrib:`Ivan Skelin`)
15+
- Add support for Neuralynx data files with :func:`mne.io.read_raw_neuralynx` (:gh:`11969` by :newcontrib:`Kristijan Armeni` and :newcontrib:`Ivan Skelin`)
916
- Improve tests for saving splits with :class:`mne.Epochs` (:gh:`11884` by `Dmitrii Altukhov`_)
1017
- Added functionality for linking interactive figures together, such that changing one figure will affect another, see :ref:`tut-ui-events` and :mod:`mne.viz.ui_events`. Current figures implementing UI events are :func:`mne.viz.plot_topomap` and :func:`mne.viz.plot_source_estimates` (:gh:`11685` :gh:`11891` by `Marijn van Vliet`_)
1118
- HTML anchors for :class:`mne.Report` now reflect the ``section-title`` of the report items rather than using a global incrementor ``global-N`` (:gh:`11890` by `Eric Larson`_)

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,7 @@
382382
"RawBrainVision",
383383
"RawCurry",
384384
"RawNIRX",
385+
"RawNeuralynx",
385386
"RawGDF",
386387
"RawSNIRF",
387388
"RawBOXY",

mne/io/neuralynx/neuralynx.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@ def read_raw_neuralynx(
3838
--------
3939
mne.io.Raw : Documentation of attributes and methods of RawNeuralynx.
4040
"""
41-
return RawNeuralynx(fname, preload, verbose, exclude_fname_patterns)
41+
return RawNeuralynx(
42+
fname,
43+
preload=preload,
44+
exclude_fname_patterns=exclude_fname_patterns,
45+
verbose=verbose,
46+
)
4247

4348

4449
@fill_doc
@@ -47,7 +52,12 @@ class RawNeuralynx(BaseRaw):
4752

4853
@verbose
4954
def __init__(
50-
self, fname, preload=False, verbose=None, exclude_fname_patterns: list = None
55+
self,
56+
fname,
57+
*,
58+
preload=False,
59+
exclude_fname_patterns=None,
60+
verbose=None,
5161
):
5262
_soft_import("neo", "Reading NeuralynxIO files", strict=True)
5363
from neo.io import NeuralynxIO

0 commit comments

Comments
 (0)