mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

DOC: docstr for `raw.get_montage` does not make sense

Open sappelhoff opened this issue 1 year ago • 1 comments

https://github.com/mne-tools/mne-python/blob/ac2c4c0d72f9843690aad70e63b48269f5269a0f/mne/_fiff/meas_info.py#L317

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.

sappelhoff avatar Sep 02 '24 21:09 sappelhoff

Agreed!

larsoner avatar Sep 03 '24 15:09 larsoner