qiskit.utils.add_deprecation_to_docstring

add_deprecation_to_docstring(func, msg, *, since, pending)

Dynamically insert the deprecation message into func's docstring.

Parameters

• func (Callable) -- The function to modify.

• msg (str) -- The full deprecation message.

• since (Optional[str]) -- The version the deprecation started at.

• pending (bool) -- Is the deprecation still pending?