qiskit.utils.deprecate_function
deprecate_function(msg, stacklevel=2, category=<class 'DeprecationWarning'>, *, since=None)
Deprecated. Instead, use @deprecate_func.
Parameters
- msg (str) – Warning message to emit.
- stacklevel (int) – The warning stacklevel to use, defaults to 2.
- category (Type[Warning]) – Usually either DeprecationWarning or PendingDeprecationWarning.
- since (str | None) – The version the deprecation started at. Only Optional for backwards compatibility - this should always be set. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update since to the new version.
Returns
The decorated, deprecated callable.
Return type
Callable
Was this page helpful?
Report a bug or request content on GitHub.