numpy.deprecate_with_doc

numpy.deprecate_with_doc(msg)[source]

Устаревает функция и включает устаревание в её документацию.

Эта функция используется как декоратор. Она возвращает объект, который может использоваться для выдачи предупреждения об устаревании, передавая функцию, которая должна быть украшена, в качестве аргумента, это добавляет предупреждение в строку документации функции, которая должна быть украшена, и возвращает новый объект функции.

Параметры

msgstr

Дополнительное объяснение устаревания. Отображается в строке документации после предупреждения.

Возвращает

objobject

См. также

deprecate

Декорировать функцию таким образом, чтобы она выводила DeprecationWarning