deprecated( update_to='', since='', reason='' )
Decorate a function to signify its deprecation.
- This function wraps a method that will soon be removed and does two things:
The docstring of the API will be modified to include a notice about deprecation.”
DeprecatedWarningwhen old API is called.
since (str) – The version at which the decorated method is considered deprecated.
update_to (str) – The new API users should use.
reason (str) – The reason why the API is deprecated.
decorated function or class.
- Return type