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

Add type overloads to Epochs.average() #12769

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

hoechenberger
Copy link
Member

@hoechenberger hoechenberger commented Aug 2, 2024

This is what I get on main (VS Code, Pylance; latest releases)

Screenshot 2024-08-02 at 11 46 43

This is what I get with this PR

Screenshot 2024-08-02 at 11 45 00

mne/epochs.py Outdated Show resolved Hide resolved
@hoechenberger
Copy link
Member Author

CircleCI complains:

/home/circleci/project/mne/epochs.py:docstring of mne.epochs.BaseEpochs.average:1: WARNING: py:class reference target not found: numpy.float64 [ref.class]

I'm a bit confused, I thought np.float64 was introduces quite a long time ago 🤔

@larsoner
Copy link
Member

larsoner commented Aug 2, 2024

From dumping the intersphinx registry with

python -m intersphinx_registry.lookup numpy > ~/Desktop/numpy.txt

I checked and it's listed under py:attribute rather than py:class

@hoechenberger
Copy link
Member Author

so it's a bug in the intersphinx file?

@larsoner
Copy link
Member

larsoner commented Aug 3, 2024

Could be a bug with their doc, or with the type handling in sphinx / autodoc / numpydoc, or could be something that we should add some ignore line for, not sure.

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