Skip to content
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.

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

ENH: Full mypy #1016

Merged
merged 5 commits into from
Oct 31, 2024
Merged

ENH: Full mypy #1016

merged 5 commits into from
Oct 31, 2024

Conversation

larsoner
Copy link
Member

Before merging …

  • Changelog has been updated (docs/source/vX.Y.md.inc)

Final parts of mypy checking. Some stuff is still disabled like:

  • full checking of tests/configs/* -- I don't think we want to add a bunch of type annotations to these as they're meant to be more human / user-readable
  • any checking of contrib/*

So I think this is the last set of changes needed for full mypy checking. Note that I created an InFilesT which is dict[str, BIDSPath] and a InFilesPathT = dict[str, BIDSPath | Path]. The latter is used much less often, and typically just with FreeSurfer-facing steps. Not 100% sure I got which-is-which correct in all cases, but probably good enough for now.

I also git mv docs/source/v1.10.md.inc docs/source/dev.md.inc because I always have to tab-tab to find the correct version number when I need to change this doc. This adds burden to every PR where I have to read the list, figure out which (next) release version we're on, and change the correct doc. With the proposed change, this per-PR burden is gone: you always change dev.md.inc. The burden is changed to a one-time-per-release cost instead (as a git mv will have to be performed there). Now our PR template can actually point to a specific file to change rather than vX.Y.md.inc.

@larsoner larsoner merged commit 91b3949 into mne-tools:main Oct 31, 2024
52 checks passed
@larsoner larsoner deleted the mypy branch October 31, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants