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

DOC: docstr for raw.get_montage does not make sense #12824

Open
sappelhoff opened this issue Sep 2, 2024 · 1 comment
Open

DOC: docstr for raw.get_montage does not make sense #12824

sappelhoff opened this issue Sep 2, 2024 · 1 comment
Milestone

Comments

@sappelhoff
Copy link
Member

%(montage)s

see: https://mne.tools/stable/generated/mne.io.Raw.html#mne.io.Raw.get_montage

image

☝️ The description is as if this were a parameter, not a return value. Furthermore, it should specify that this returns a copy of a montage, so modifying this in any way won't have an impact on the raw instance from which it is obtained.

@larsoner
Copy link
Member

larsoner commented Sep 3, 2024

Agreed!

@larsoner larsoner added this to the 1.9 milestone Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants