Skip to content

Type public Epochs, Evoked, and io members fully #14056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
larsoner merged 5 commits into from
Jul 23, 2026
Merged

Type public Epochs, Evoked, and io members fully #14056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba2688c
Type public Epochs, Evoked, and io members fully
larsoner Jul 14, 2026
477c069
FIX: Log
larsoner Jul 14, 2026
f9189a8
FIX: autodoc typehints are a pain
larsoner Jul 14, 2026
4388332
FIX: Comments
larsoner Jul 23, 2026
2322652
Merge upstream/main into typed-fully
larsoner Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/14056.newfeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added type annotations to public members of ``mne/io``, :class:`mne.Evoked`, and :class:`mne.Epochs`, by `Eric Larson`_.
3 changes: 3 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,6 +738,9 @@ def fix_sklearn_inherited_docstrings(app, what, name, obj, options, lines):
# autodoc / autosummary
autosummary_generate = True
autodoc_default_options = {"inherited-members": None}
# Types are documented (in human-readable numpydoc form) in the docstrings
# themselves, so don't also render the annotations into the signatures.
autodoc_typehints = "none"

# sphinxcontrib-bibtex
bibtex_bibfiles = ["./references.bib"]
Expand Down
8 changes: 4 additions & 4 deletions mne/defaults.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Copyright the MNE-Python contributors.

from copy import deepcopy
from typing import Any
from typing import Any, Final

DEFAULTS: dict[str, Any] = dict(
color=dict(
Expand Down Expand Up @@ -405,6 +405,6 @@ def _handle_default(k, v=None):


HEAD_SIZE_DEFAULT = 0.095 # in [m]
_BORDER_DEFAULT = "mean"
_INTERPOLATION_DEFAULT = "cubic"
_EXTRAPOLATE_DEFAULT = "auto"
_BORDER_DEFAULT: Final = "mean"
_INTERPOLATION_DEFAULT: Final = "cubic"
_EXTRAPOLATE_DEFAULT: Final = "auto"
Loading
Loading