class mne.utils.deprecated(extra)[source]#

Mark a function, class, or method as deprecated (decorator).

Originally adapted from sklearn and, then modified to make arguments populate properly following our verbose decorator methods based on decorator.


Extra information beyond just saying the class/function/method is deprecated. Should be a complete sentence (trailing period will be added automatically). Will be included in FutureWarning messages and in a sphinx warning box in the docstring.