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.
docstr: Call.
  Parameters
  ----------
  obj : object
      Object to call.
docstr_tok: ["Call",".","Parameters","--","--","--","--","--","obj",":","object","Object","to","call","."]
code: def __call__(self, obj):
      """Call.
      Parameters
      ----------
      obj : object
          Object to call.
      """
      if isinstance(obj, type):
          return self._decorate_class(obj)
      else:
          return self._decorate_fun(obj)
  
file_path: pyRiemann/pyriemann/utils/docs.py
imports: import warnings
label_desc: Use image node_id 2 for calling the deprecated obj's underlying member method code with example usage: obj.__call__(obj) and returns: self, self