Add "deprecated" to docstring (#1970)

Qiskit · Oct 15, 2024 · bd3a42a · bd3a42a
1 parent b9fbc0c
commit bd3a42a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/qiskit_ibm_runtime/runtime_job.py b/qiskit_ibm_runtime/runtime_job.py
@@ -369,7 +369,7 @@ def backend(self, timeout: Optional[float] = None) -> Optional[Backend]:
     def stream_results(
         self, callback: Callable, decoder: Optional[Type[ResultDecoder]] = None
     ) -> None:
-        """Start streaming job results.
+        """(DEPRECATED) Start streaming job results.
 
         Args:
             callback: Callback function to be invoked for any interim results and final result.
@@ -398,7 +398,7 @@ def stream_results(
 
     @deprecate_function("interim_results()", "0.25", "", stacklevel=1)
     def interim_results(self, decoder: Optional[Type[ResultDecoder]] = None) -> Any:
-        """Return the interim results of the job.
+        """(DEPRECATED) Return the interim results of the job.
 
         Args:
             decoder: A :class:`ResultDecoder` subclass used to decode interim results.

diff --git a/qiskit_ibm_runtime/runtime_job_v2.py b/qiskit_ibm_runtime/runtime_job_v2.py
@@ -276,7 +276,7 @@ def backend(self, timeout: Optional[float] = None) -> Optional[Backend]:
     def stream_results(
         self, callback: Callable, decoder: Optional[Type[ResultDecoder]] = None
     ) -> None:
-        """Start streaming job results.
+        """(DEPRECATED) Start streaming job results.
 
         Args:
             callback: Callback function to be invoked for any interim results and final result.
@@ -305,7 +305,7 @@ def stream_results(
 
     @deprecate_function("interim_results()", "0.25", "", stacklevel=1)
     def interim_results(self, decoder: Optional[Type[ResultDecoder]] = None) -> Any:
-        """Return the interim results of the job.
+        """(DEPRECATED) Return the interim results of the job.
 
         Args:
             decoder: A :class:`ResultDecoder` subclass used to decode interim results.