Fix incorrect type hint in Neuralynx I/O module (#12236)

mne-tools · Nov 28, 2023 · b876edb · b876edb
1 parent 6e93117
commit b876edb
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/doc/api/reading_raw_data.rst b/doc/api/reading_raw_data.rst
@@ -40,6 +40,7 @@ Reading raw data
    read_raw_nihon
    read_raw_fil
    read_raw_nsx
+   read_raw_neuralynx
 
 Base class:
 

diff --git a/doc/changes/v1.6.rst b/doc/changes/v1.6.rst
@@ -1,11 +1,18 @@
+.. _changes_1_6_1:
+
+Version 1.6.1 (unreleased)
+--------------------------
+
+- Fix bug with type hints in :func:`mne.io.read_raw_neuralynx` (:gh:`12236` by `Richard Höchenberger`_)
+
 .. _changes_1_6_0:
 
 Version 1.6.0 (2023-11-20)
 --------------------------
 
 Enhancements
 ~~~~~~~~~~~~
-- Add support for Neuralynx data files with ``mne.io.read_raw_neuralynx`` (:gh:`11969` by :newcontrib:`Kristijan Armeni` and :newcontrib:`Ivan Skelin`)
+- Add support for Neuralynx data files with :func:`mne.io.read_raw_neuralynx` (:gh:`11969` by :newcontrib:`Kristijan Armeni` and :newcontrib:`Ivan Skelin`)
 - Improve tests for saving splits with :class:`mne.Epochs` (:gh:`11884` by `Dmitrii Altukhov`_)
 - 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`_)
 - 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`_)

diff --git a/doc/conf.py b/doc/conf.py
@@ -382,6 +382,7 @@
     "RawBrainVision",
     "RawCurry",
     "RawNIRX",
+    "RawNeuralynx",
     "RawGDF",
     "RawSNIRF",
     "RawBOXY",

diff --git a/mne/io/neuralynx/neuralynx.py b/mne/io/neuralynx/neuralynx.py
@@ -38,7 +38,12 @@ def read_raw_neuralynx(
     --------
     mne.io.Raw : Documentation of attributes and methods of RawNeuralynx.
     """
-    return RawNeuralynx(fname, preload, verbose, exclude_fname_patterns)
+    return RawNeuralynx(
+        fname,
+        preload=preload,
+        exclude_fname_patterns=exclude_fname_patterns,
+        verbose=verbose,
+    )
 
 
 @fill_doc
@@ -47,7 +52,12 @@ class RawNeuralynx(BaseRaw):
 
     @verbose
     def __init__(
-        self, fname, preload=False, verbose=None, exclude_fname_patterns: list = None
+        self,
+        fname,
+        *,
+        preload=False,
+        exclude_fname_patterns=None,
+        verbose=None,
     ):
         _soft_import("neo", "Reading NeuralynxIO files", strict=True)
         from neo.io import NeuralynxIO