numpy.deprecate_with_doc

numpy.deprecate_with_doc(msg)[源代码]

弃用函数并在其docstring中包含弃用。

此函数用作修饰符。它返回一个可用于发出DeprecationWarning的对象,通过将要修饰的函数作为参数传递,这将向要修饰的函数的docstring添加警告并返回新的函数对象。

参数
msgSTR

反对意见的补充说明。显示在警告后的docstring中。

返回
obj对象

参见

deprecate

修饰函数使其发出 DeprecationWarning