class_docstr: Decorator to mark a function or class as deprecated.
  
  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 sklearn.utils import deprecated
  >>> deprecated() # doctest: +ELLIPSIS
  <sklearn.utils.deprecation.deprecated object at ...>
  
  >>> @deprecated()
  ... def some_function(): pass
docstr: Parameters
  ----------
  extra: string
    to be added to the deprecation messages
docstr_tok: ["Parameters","--","--","--","--","--","extra",":","string","to","be","added","to","the","deprecation","messages"]
code: def __init__(self, extra=""):
      """
      Parameters
      ----------
      extra: string
        to be added to the deprecation messages
  
      """
      self.extra = extra
  
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)