API: mne.preprocessing.mark_flat --> mne.preprocessing.annotate_flat ?

With the relatively new Annotations in MNE, there are now (at least) two functions that work on raw data and return annotations:

• mne.preprocessing.annotate_muscle_z_score
• mne.preprocessing.annotate_movement

There is an older function operating in a similar style: mne.preprocessing.mark_flat

Would it make sense to change this to mne.preprocessing.anotate_flat to have a set of functions with a consistent API working on raw data and providing annotations?

[larsoner]

(if someone calls mark_flat in 0.21 it should do the same thing as in 0.20 but give dep warning, annotate_flat should do whatever we want annotate_* functions to do)

[drammock]

But we should make sure that the current mark_flat, if renamed to annotate_flat, matches the behavior of the existing annotate_* functions, namely, stop modifying the input in-place, and return Annotations instead.

Agreed; I think that was part of @sappelhoff’s original proposal.