Deprecate warning box in docs

qiskit/algorithms/amplitude_amplifiers/grover.py

@@ -196,6 +196,7 @@ def __init__(
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self) -> Optional[QuantumInstance]:
         r"""Pending deprecation\; Get the quantum instance.
@@ -211,6 +212,7 @@ def quantum_instance(self) -> Optional[QuantumInstance]:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self, quantum_instance: Union[QuantumInstance, Backend]) -> None:
         r"""Pending deprecation\; Set quantum instance.

qiskit/algorithms/amplitude_estimators/ae.py

@@ -129,6 +129,7 @@ def sampler(self, sampler: BaseSampler) -> None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self) -> QuantumInstance | None:
         """Pending deprecation; Get the quantum instance.
@@ -144,6 +145,7 @@ def quantum_instance(self) -> QuantumInstance | None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None:
         """Pending deprecation; Set quantum instance.

qiskit/algorithms/amplitude_estimators/fae.py

@@ -114,6 +114,7 @@ def sampler(self, sampler: BaseSampler) -> None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self) -> QuantumInstance | None:
         """Pending deprecation; Get the quantum instance.
@@ -129,6 +130,7 @@ def quantum_instance(self) -> QuantumInstance | None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None:
         """Pending deprecation; Set quantum instance.

qiskit/algorithms/amplitude_estimators/iae.py

@@ -137,6 +137,7 @@ def sampler(self, sampler: BaseSampler) -> None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self) -> QuantumInstance | None:
         """Pending deprecation; Get the quantum instance.
@@ -152,6 +153,7 @@ def quantum_instance(self) -> QuantumInstance | None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None:
         """Pending deprecation; Set quantum instance.

qiskit/algorithms/amplitude_estimators/mlae.py

@@ -141,6 +141,7 @@ def sampler(self, sampler: BaseSampler) -> None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self) -> QuantumInstance | None:
         """Pending deprecation; Get the quantum instance.
@@ -156,6 +157,7 @@ def quantum_instance(self) -> QuantumInstance | None:
         "This property will be deprecated in a future release and subsequently "
         "removed after that.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None:
         """Pending deprecation; Set quantum instance.

qiskit/algorithms/aux_ops_evaluator.py

@@ -33,10 +33,9 @@
 
 @deprecate_function(
     "The eval_observables function has been superseded by the "
-    "qiskit.algorithms.observables_evaluator.estimate_observables function. "
-    "This function will be deprecated in a future release and subsequently "
-    "removed after that.",
+    "qiskit.algorithms.observables_evaluator.estimate_observables function. ",
     category=PendingDeprecationWarning,
+    since="0.23.0",
 )
 def eval_observables(
     quantum_instance: Union[QuantumInstance, Backend],

qiskit/algorithms/eigen_solvers/eigen_solver.py

@@ -38,10 +38,9 @@ class Eigensolver(ABC):
 
     @deprecate_function(
         "The Eigensolver interface has been superseded by the "
-        "qiskit.algorithms.eigensolvers.Eigensolver interface. "
-        "This interface will be deprecated in a future release and subsequently "
-        "removed after that.",
-        category=PendingDeprecationWarning,
+        "qiskit.algorithms.eigensolvers.Eigensolver interface. ",
+        category=DeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         pass
@@ -90,10 +89,9 @@ class EigensolverResult(AlgorithmResult):
 
     @deprecate_function(
         "The EigensolverResult class has been superseded by the "
-        "qiskit.algorithms.eigensolvers.EigensolverResult class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.eigensolvers.EigensolverResult class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py

@@ -51,10 +51,9 @@ class NumPyEigensolver(Eigensolver):
 
     @deprecate_function(
         "The NumPyEigensolver class has been superseded by the "
-        "qiskit.algorithms.eigensolvers.NumPyEigensolver class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.eigensolvers.NumPyEigensolver class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,

qiskit/algorithms/eigen_solvers/vqd.py

@@ -97,11 +97,9 @@ class VQD(VariationalAlgorithm, Eigensolver):
     """
 
     @deprecate_function(
-        "The VQD class has been superseded by the "
-        "qiskit.algorithms.eigensolvers.VQD class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "The VQD class has been superseded by the " "qiskit.algorithms.eigensolvers.VQD class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,
@@ -768,10 +766,9 @@ class VQDResult(VariationalResult, EigensolverResult):
 
     @deprecate_function(
         "The VQDResult class has been superseded by the "
-        "qiskit.algorithms.eigensolvers.VQDResult class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.eigensolvers.VQDResult class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/evolvers/evolution_problem.py

@@ -35,10 +35,9 @@ class EvolutionProblem:
 
     @deprecate_function(
         "The EvolutionProblem class has been superseded by the "
-        "qiskit.algorithms.time_evolvers.TimeEvolutionProblem class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.time_evolvers.TimeEvolutionProblem class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,

qiskit/algorithms/evolvers/evolution_result.py

@@ -33,10 +33,9 @@ class EvolutionResult(AlgorithmResult):
 
     @deprecate_function(
         "The EvolutionResult class has been superseded by the "
-        "qiskit.algorithms.time_evolvers.TimeEvolutionResult class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.time_evolvers.TimeEvolutionResult class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,

qiskit/algorithms/evolvers/imaginary_evolver.py

@@ -31,10 +31,9 @@ class ImaginaryEvolver(ABC):
 
     @deprecate_function(
         "The ImaginaryEvolver interface has been superseded by the "
-        "qiskit.algorithms.time_evolvers.ImaginaryTimeEvolver interface. "
-        "This interface will be deprecated in a future release and subsequently "
-        "removed after that.",
-        category=PendingDeprecationWarning,
+        "qiskit.algorithms.time_evolvers.ImaginaryTimeEvolver interface. ",
+        category=DeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         pass

qiskit/algorithms/evolvers/real_evolver.py

@@ -31,10 +31,9 @@ class RealEvolver(ABC):
 
     @deprecate_function(
         "The RealEvolver interface has been superseded by the "
-        "qiskit.algorithms.time_evolvers.RealTimeEvolver interface. "
-        "This interface will be deprecated in a future release and subsequently "
-        "removed after that.",
-        category=PendingDeprecationWarning,
+        "qiskit.algorithms.time_evolvers.RealTimeEvolver interface. ",
+        category=DeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         pass

qiskit/algorithms/evolvers/trotterization/trotter_qrte.py

@@ -66,10 +66,9 @@ class TrotterQRTE(RealEvolver):
 
     @deprecate_function(
         "The TrotterQRTE class has been superseded by the "
-        "qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,

qiskit/algorithms/factorizers/shor.py

@@ -60,7 +60,8 @@ class Shor:
         """The Shor class is deprecated as of Qiskit Terra 0.22.0 and will be removed
         no sooner than 3 months after the release date.
         It is replaced by the tutorial at https://qiskit.org/textbook/ch-algorithms/shor.html
-        """
+        """,
+        since="0.22.0",
     )
     def __init__(self, quantum_instance: Optional[Union[QuantumInstance, Backend]] = None) -> None:
         """

qiskit/algorithms/linear_solvers/hhl.py

@@ -110,7 +110,8 @@ class HHL(LinearSolver):
         """The HHL class is deprecated as of Qiskit Terra 0.22.0 and will be removed
         no sooner than 3 months after the release date.
         It is replaced by the tutorial at https://qiskit.org/textbook/ch-applications/hhl_tutorial.html"
-        """
+        """,
+        since="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/linear_solver.py

@@ -34,7 +34,8 @@ class LinearSolverResult(AlgorithmResult):
 
     @deprecate_function(
         "The LinearSolverResult class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(self) -> None:
         super().__init__()
@@ -102,7 +103,8 @@ class LinearSolver(ABC):
 
     @deprecate_function(
         "The LinearSolver class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(self) -> None:
         pass

qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py

@@ -25,7 +25,8 @@ class LinearSystemMatrix(BlueprintCircuit, ABC):
 
     @deprecate_function(
         "The LinearSystemMatrix class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py

@@ -48,7 +48,8 @@ class NumPyMatrix(LinearSystemMatrix):
 
     @deprecate_function(
         "The NumPyMatrix class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py

@@ -60,7 +60,8 @@ class TridiagonalToeplitz(LinearSystemMatrix):
 
     @deprecate_function(
         "The TridiagonalToeplitz class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/numpy_linear_solver.py

@@ -53,7 +53,8 @@ class NumPyLinearSolver(LinearSolver):
 
     @deprecate_function(
         "The NumPyLinearSolver class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/linear_solvers/observables/absolute_average.py

@@ -63,7 +63,8 @@ class AbsoluteAverage(LinearSystemObservable):
 
     @deprecate_function(
         "The AbsoluteAverage class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/linear_solvers/observables/linear_system_observable.py

@@ -26,7 +26,8 @@ class LinearSystemObservable(ABC):
 
     @deprecate_function(
         "The LinearSystemObservable class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(self) -> None:
         pass

qiskit/algorithms/linear_solvers/observables/matrix_functional.py

@@ -75,7 +75,8 @@ class MatrixFunctional(LinearSystemObservable):
 
     @deprecate_function(
         "The MatrixFunctional class is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the release date. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        since="0.22.0",
     )
     def __init__(self, main_diag: float, off_diag: int) -> None:
         """

qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py

@@ -38,10 +38,9 @@ class MinimumEigensolver(ABC):
 
     @deprecate_function(
         "The Minimum Eigensolver interface has been superseded by the "
-        "qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver interface. "
-        "This interface will be deprecated in a future release and subsequently "
-        "removed after that.",
-        category=PendingDeprecationWarning,
+        "qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver interface. ",
+        category=DeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         pass
@@ -94,10 +93,9 @@ class MinimumEigensolverResult(AlgorithmResult):
 
     @deprecate_function(
         "The MinimumEigensolverResult class has been superseded by the "
-        "qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult class.",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py

@@ -39,10 +39,9 @@ class NumPyMinimumEigensolver(MinimumEigensolver):
 
     @deprecate_function(
         "The NumPyMinimumEigensolver class has been superseded by the "
-        "qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,

qiskit/algorithms/minimum_eigen_solvers/qaoa.py

@@ -61,10 +61,9 @@ class QAOA(VQE):
 
     @deprecate_function(
         "The QAOA class has been superseded by the "
-        "qiskit.algorithms.minimum_eigensolvers.QAOA class. "
-        "This class will be deprecated in a future release and subsequently "
-        "removed after that.",
+        "qiskit.algorithms.minimum_eigensolvers.QAOA class. ",
         category=PendingDeprecationWarning,
+        since="0.23.0",
     )
     def __init__(
         self,