argopy.utilities.deprecated
argopy.utilities.deprecated#
- deprecated(reason)[source]#
Deprecation warning decorator.
This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.
- Parameters
reason ({str, None}) – Text message to send with deprecation warning
Examples
The @deprecated can be used with a ‘reason’.
@deprecated("please, use another function") def old_function(x, y): pass
or without:
@deprecated def old_function(x, y): pass
References