deprecate_kwarg#

deprecate_kwarg(old_name: str, new_name: Optional[str] = None) Callable[[F], F][source]#

Decorate a function with deprecated kwargs.

Parameters
old_arg_namestr

Name of argument in function to deprecate

new_arg_nameOptional[str], default None

Name of preferred argument in function.