Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

qiskit.utils.add_deprecation_to_docstring

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

GitHub

Dynamically insert the deprecation message into func’s docstring.

Parameters

  • func (Callable) – The function to modify.
  • msg (str) – The full deprecation message.
  • since (str | None) – The version the deprecation started at.
  • pending (bool) – Is the deprecation still pending?
Was this page helpful?
Report a bug or request content on GitHub.