mne-tools / mne-python

MNE: Magnetoencephalography (MEG) and Electroencephalography (EEG) in Python
https://mne.tools
BSD 3-Clause "New" or "Revised" License
2.7k stars 1.31k forks source link

[ENH] [Doc] Annotations onset #4906

Closed annesodub closed 6 years ago

annesodub commented 6 years ago

Based on the documentation, it is unclear if onsets are expressed in seconds or samples (or anything else).

Parameters
----------
onset : array of float, shape (n_annotations,)
    Annotation time onsets relative to the ``orig_time``, the starting time
    of annotation acquisition.
massich commented 6 years ago

Indeed, the documentation fails to say that onset should be in seconds.

makkostya commented 6 years ago

Ill do PR.

massich commented 6 years ago

go for it !