class_docstr: Mark a function or class as deprecated (decorator).
  
  Issue a warning when the function is called/the class is instantiated and
  adds a warning to the docstring.
  
  The optional extra argument will be appended to the deprecation message
  and the docstring. Note: to use this with the default value for extra, put
  in an empty of parentheses::
  
      >>> from pyriemann.utils import deprecated
      >>> deprecated()
      <pyriemann.utils.docs.deprecated object at ...>
      >>> @deprecated()
      ... def some_function(): pass
  
  
  Parameters
  ----------
  extra: string
      To be added to the deprecation messages.
code: def __init__(self, extra=""):
      self.extra = extra
  
file_path: pyRiemann/pyriemann/utils/docs.py
imports: import warnings
label_desc: Use image node_id 1 to create a new deprecated object from inherited base classes: object with example: obj = deprecated(extra)