warn

Warn of (pending) deprecation.

def warn(
    description: string = None,
    deprecation: string = None,
    removal: string = None,
    alternative: string = None,
    stacklevel: integer = 2
) - > null

Warn of (pending) deprecation.

Parameters

Name	Type	Description
description	string = None	A brief explanation of the feature or behavior being deprecated.
deprecation	string = None	The version or date when the feature was first marked as deprecated; if provided, a pending deprecation warning is issued.
removal	string = None	The version or date when the feature is scheduled to be removed from the codebase.
alternative	string = None	A suggested replacement or alternative approach for callers to use instead of the deprecated feature.
stacklevel	integer = 2	The number of stack frames to skip when reporting the warning location, ensuring the warning points to the caller.

Returns

Type	Description
null	Nothing; this function issues a warning to the standard warning system.