Deprecate warning box in docs

qiskit/algorithms/factorizers/shor.py

@@ -58,7 +58,8 @@ class Shor:
 
     @deprecate_function(
         "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. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        docstring_version="0.22.0",
     )
     def __init__(self, quantum_instance: Optional[Union[QuantumInstance, Backend]] = None) -> None:
         """

qiskit/algorithms/linear_solvers/hhl.py

@@ -105,7 +105,8 @@ class HHL(LinearSolver):
 
     @deprecate_function(
         "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. "
+        "and will be removed no sooner than 3 months after the release date. ",
+        docstring_version="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. ",
+        docstring_version="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. ",
+        docstring_version="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. ",
+        docstring_version="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py

@@ -50,7 +50,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. ",
+        docstring_version="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py

@@ -62,7 +62,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. ",
+        docstring_version="0.22.0",
     )
     def __init__(
         self,

qiskit/algorithms/linear_solvers/numpy_linear_solver.py

@@ -55,7 +55,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. ",
+        docstring_version="0.22.0",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/linear_solvers/observables/absolute_average.py

@@ -65,7 +65,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. ",
+        docstring_version="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. ",
+        docstring_version="0.22.0",
     )
     def __init__(self) -> None:
         pass

qiskit/algorithms/linear_solvers/observables/matrix_functional.py

@@ -77,7 +77,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. ",
+        docstring_version="0.22.0",
     )
     def __init__(self, main_diag: float, off_diag: int) -> None:
         """

qiskit/algorithms/optimizers/adam_amsgrad.py

@@ -198,7 +198,8 @@ def load_params(self, load_dir: str) -> None:
             "objective_function": "fun",
             "initial_point": "x0",
             "gradient_function": "jac",
-        }
+        },
+        docstring_version="0.19.0",
     )
     # pylint: disable=arguments-differ
     def minimize(

qiskit/algorithms/optimizers/spsa.py

@@ -651,7 +651,8 @@ def get_support_level(self):
         "The SPSA.optimize method is deprecated as of Qiskit Terra 0.21.0 and will be removed no "
         "sooner than 3 months after the release date. Instead, use SPSA.minimize as a replacement, "
         "which supports the same arguments but follows the interface of scipy.optimize and returns "
-        "a complete result object containing additional information."
+        "a complete result object containing additional information.",
+        docstring_version="0.21.0",
     )
     def optimize(
         self,

qiskit/algorithms/phase_estimators/phase_estimation_result.py

@@ -71,7 +71,8 @@ def circuit_result(self) -> Result:
     @deprecate_function(
         """The 'PhaseEstimationResult.most_likely_phase' attribute
                         is deprecated as of 0.18.0 and will be removed no earlier than 3 months
-                        after the release date. It has been renamed as the 'phase' attribute."""
+                        after the release date. It has been renamed as the 'phase' attribute.""",
+        docstring_version="0.18.0",
     )
     def most_likely_phase(self) -> float:
         r"""DEPRECATED - Return the most likely phase as a number in :math:`[0.0, 1.0)`.

qiskit/circuit/quantumcircuit.py

@@ -716,10 +716,11 @@ def control(
     @deprecate_function(
         "The QuantumCircuit.combine() method is being deprecated. "
         "Use the compose() method which is more flexible w.r.t "
-        "circuit register compatibility."
+        "circuit register compatibility.",
+        docstring_version="0.17.0",
     )
     def combine(self, rhs: "QuantumCircuit") -> "QuantumCircuit":
-        """DEPRECATED - Returns rhs appended to self if self contains compatible registers.
+        """Returns rhs appended to self if self contains compatible registers.
 
         Two circuits are compatible if they contain the same registers
         or if they contain different registers with unique names. The
@@ -768,7 +769,8 @@ def combine(self, rhs: "QuantumCircuit") -> "QuantumCircuit":
     @deprecate_function(
         "The QuantumCircuit.extend() method is being deprecated. Use the "
         "compose() (potentially with the inplace=True argument) and tensor() "
-        "methods which are more flexible w.r.t circuit register compatibility."
+        "methods which are more flexible w.r.t circuit register compatibility.",
+        docstring_version="0.17.0",
     )
     def extend(self, rhs: "QuantumCircuit") -> "QuantumCircuit":
         """DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers.
@@ -3765,7 +3767,8 @@ def cu(
         "0.16.0. It will be removed no earlier than 3 months "
         "after the release date. You should use the "
         "QuantumCircuit.p method instead, which acts "
-        "identically."
+        "identically.",
+        docstring_version="0.16.0",
     )
     def u1(self, theta: ParameterValueType, qubit: QubitSpecifier) -> InstructionSet:
         r"""Apply :class:`~qiskit.circuit.library.U1Gate`.
@@ -3788,7 +3791,8 @@ def u1(self, theta: ParameterValueType, qubit: QubitSpecifier) -> InstructionSet
         "0.16.0. It will be removed no earlier than 3 months "
         "after the release date. You should use the "
         "QuantumCircuit.cp method instead, which acts "
-        "identically."
+        "identically.",
+        docstring_version="0.16.0",
     )
     def cu1(
         self,
@@ -3825,7 +3829,8 @@ def cu1(
         "0.16.0. It will be removed no earlier than 3 months "
         "after the release date. You should use the "
         "QuantumCircuit.mcp method instead, which acts "
-        "identically."
+        "identically.",
+        docstring_version="0.16.0",
     )
     def mcu1(
         self,
@@ -3857,7 +3862,8 @@ def mcu1(
         "qubit gate QuantumCircuit.u instead: u2(φ,λ) = "
         "u(π/2, φ, λ). Alternatively, you can decompose it in"
         "terms of QuantumCircuit.p and QuantumCircuit.sx: "
-        "u2(φ,λ) = p(π/2+φ) sx p(λ-π/2) (1 pulse on hardware)."
+        "u2(φ,λ) = p(π/2+φ) sx p(λ-π/2) (1 pulse on hardware).",
+        docstring_version="0.16.0",
     )
     def u2(
         self, phi: ParameterValueType, lam: ParameterValueType, qubit: QubitSpecifier
@@ -3883,7 +3889,8 @@ def u2(
         "removed no earlier than 3 months after the release date. You should use "
         "QuantumCircuit.u instead, which acts identically. Alternatively, you can "
         "decompose u3 in terms of QuantumCircuit.p and QuantumCircuit.sx: "
-        "u3(ϴ,φ,λ) = p(φ+π) sx p(ϴ+π) sx p(λ) (2 pulses on hardware)."
+        "u3(ϴ,φ,λ) = p(φ+π) sx p(ϴ+π) sx p(λ) (2 pulses on hardware).",
+        docstring_version="0.16.0",
     )
     def u3(
         self,
@@ -3913,7 +3920,8 @@ def u3(
         "The QuantumCircuit.cu3 method is deprecated as of 0.16.0. It will be "
         "removed no earlier than 3 months after the release date. You should "
         "use the QuantumCircuit.cu method instead, where "
-        "cu3(ϴ,φ,λ) = cu(ϴ,φ,λ,0)."
+        "cu3(ϴ,φ,λ) = cu(ϴ,φ,λ,0).",
+        docstring_version="0.16.0",
     )
     def cu3(
         self,

qiskit/dagcircuit/dagcircuit.py

@@ -97,7 +97,8 @@ def __init__(self):
 
     @_optionals.HAS_NETWORKX.require_in_call
     @deprecate_function(
-        "The to_networkx() method is deprecated and will be removed in a future release."
+        "The to_networkx() method is deprecated and will be removed in a future release.",
+        docstring_version="0.21.0",
     )
     def to_networkx(self):
         """Returns a copy of the DAGCircuit in networkx format."""
@@ -114,7 +115,8 @@ def to_networkx(self):
     @classmethod
     @_optionals.HAS_NETWORKX.require_in_call
     @deprecate_function(
-        "The from_networkx() method is deprecated and will be removed in a future release."
+        "The from_networkx() method is deprecated and will be removed in a future release.",
+        docstring_version="0.21.0",
     )
     def from_networkx(cls, graph):
         """Take a networkx MultiDigraph and create a new DAGCircuit.
@@ -503,7 +505,8 @@ def _add_op_node(self, op, qargs, cargs):
         """The DAGCircuit._copy_circuit_metadata method is deprecated as of 0.20.0. It will be removed
         no earlier than 3 months after the release date. You should use the DAGCircuit.copy_empty_like
         method instead, which acts identically.
-        """
+        """,
+        docstring_version="0.20.0",
     )
     def _copy_circuit_metadata(self):
         """DEPRECATED"""

qiskit/primitives/base_estimator.py

@@ -219,16 +219,18 @@ def __new__(
 
     @deprecate_function(
         "The BaseEstimator.__enter__ method is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the releasedate. "
+        "and will be removed no sooner than 3 months after the release date. "
         "BaseEstimator should be initialized directly.",
+        docstring_version="0.22.0",
     )
     def __enter__(self):
         return self
 
     @deprecate_function(
         "The BaseEstimator.__exit__ method is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the releasedate. "
+        "and will be removed no sooner than 3 months after the release date. "
         "BaseEstimator should be initialized directly.",
+        docstring_version="0.22.0",
     )
     def __exit__(self, *exc_info):
         self.close()
@@ -283,10 +285,14 @@ def set_run_options(self, **fields) -> BaseEstimator:
 
     @deprecate_function(
         "The BaseSampler.__call__ method is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the releasedate. "
+        "and will be removed no sooner than 3 months after the release date. "
         "Use run method instead.",
+        docstring_version="0.22.0",
+    )
+    @deprecate_arguments(
+        {"circuit_indices": "circuits", "observable_indices": "observables"},
+        docstring_version="0.21.0",
     )
-    @deprecate_arguments({"circuit_indices": "circuits", "observable_indices": "observables"})
     def __call__(
         self,
         circuits: Sequence[int | QuantumCircuit],

qiskit/primitives/base_sampler.py

@@ -179,15 +179,15 @@ def __new__(
 
     @deprecate_function(
         "The BaseSampler.__enter__ method is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the releasedate. "
+        "and will be removed no sooner than 3 months after the release date. "
         "BaseSampler should be initialized directly.",
     )
     def __enter__(self):
         return self
 
     @deprecate_function(
         "The BaseSampler.__exit__ method is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the releasedate. "
+        "and will be removed no sooner than 3 months after the release date. "
         "BaseSampler should be initialized directly.",
     )
     def __exit__(self, *exc_info):
@@ -234,10 +234,10 @@ def set_run_options(self, **fields) -> BaseSampler:
 
     @deprecate_function(
         "The BaseSampler.__call__ method is deprecated as of Qiskit Terra 0.22.0 "
-        "and will be removed no sooner than 3 months after the releasedate. "
+        "and will be removed no sooner than 3 months after the release date. "
         "Use run method instead.",
     )
-    @deprecate_arguments({"circuit_indices": "circuits"})
+    @deprecate_arguments({"circuit_indices": "circuits"}, docstring_version="0.21.0")
     def __call__(
         self,
         circuits: Sequence[int | QuantumCircuit],

qiskit/qpy/interface.py

@@ -72,7 +72,7 @@
 VERSION_PATTERN_REGEX = re.compile(VERSION_PATTERN, re.VERBOSE | re.IGNORECASE)
 
 
-@deprecate_arguments({"circuits": "programs"})
+@deprecate_arguments({"circuits": "programs"}, docstring_version="0.21.0")
 def dump(
     programs: Union[List[QPY_SUPPORTED_TYPES], QPY_SUPPORTED_TYPES],
     file_obj: BinaryIO,

qiskit/scheduler/utils.py

@@ -15,12 +15,14 @@
 from qiskit.utils.deprecation import deprecate_function
 from qiskit.pulse import macros, utils
 
-format_meas_map = deprecate_function('"format_meas_map" has been moved to "qiskit.pulse.utils"')(
-    utils.format_meas_map
-)
+format_meas_map = deprecate_function(
+    '"format_meas_map" has been moved to "qiskit.pulse.utils"', docstring_version="0.15.0"
+)(utils.format_meas_map)
 
-measure = deprecate_function('"measure" has been moved to "qiskit.pulse.macros"')(macros.measure)
+measure = deprecate_function(
+    '"measure" has been moved to "qiskit.pulse.macros"', docstring_version="0.15.0"
+)(macros.measure)
 
-measure_all = deprecate_function('"measure_all" has been moved to "qiskit.pulse.macros"')(
-    macros.measure_all
-)
+measure_all = deprecate_function(
+    '"measure_all" has been moved to "qiskit.pulse.macros"', docstring_version="0.15.0"
+)(macros.measure_all)

qiskit/transpiler/passes/basis/decompose.py

@@ -25,7 +25,7 @@
 class Decompose(TransformationPass):
     """Expand a gate in a circuit using its decomposition rules."""
 
-    @deprecate_arguments({"gate": "gates_to_decompose"})
+    @deprecate_arguments({"gate": "gates_to_decompose"}, docstring_version="0.19.0")
     def __init__(
         self,
         gate: Optional[Type[Gate]] = None,