From bd3a42adb82d54cbedce737160963992dd82b59f Mon Sep 17 00:00:00 2001 From: Kevin Tian Date: Tue, 15 Oct 2024 12:15:52 -0400 Subject: [PATCH] Add "deprecated" to docstring (#1970) --- qiskit_ibm_runtime/runtime_job.py | 4 ++-- qiskit_ibm_runtime/runtime_job_v2.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/qiskit_ibm_runtime/runtime_job.py b/qiskit_ibm_runtime/runtime_job.py index cdbb27864..a5eaa7418 100644 --- 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 index 9cf7ebb42..f4b95d804 100644 --- 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.