function deprecated_argument

deeptime.util.decorators.deprecated_argument(argument_name, replaced_by, msg)

Marks an argument of a function as deprecated. Only works for keyword arguments.

Parameters:

• argument_name (str) – The deprecated argument.

• replaced_by (str) – The replacement.

• msg (str) – Warning message.

Returns:

factory – decorator factory parametrized by arguments

Return type:

callable