bundles / numpy 2.4.4 / numpy / lib / _utils_impl / deprecate_with_doc
function
numpy.lib._utils_impl:deprecate_with_doc
source: /numpy/lib/_utils_impl.py :272
Signature
def deprecate_with_doc ( msg ) Summary
Deprecates a function and includes the deprecation in its docstring.
Extended Summary
This function is used as a decorator. It returns an object that can be used to issue a DeprecationWarning, by passing the to-be decorated function as argument, this adds warning to the to-be decorated function's docstring and returns the new function object.
Parameters
msg: strAdditional explanation of the deprecation. Displayed in the docstring after the warning.
Returns
obj: object
See also
- deprecate
Decorate a function such that it issues a
DeprecationWarning
Aliases
-
numpy.lib._utils_impl.deprecate_with_doc