scrub RuntimeOptions from docs (#1808)

Qiskit · Jul 18, 2024 · 55d0abb · 55d0abb
1 parent 674017d
commit 55d0abb
Show file tree

Hide file tree

Showing 6 changed files with 0 additions and 8 deletions.
diff --git a/qiskit_ibm_runtime/__init__.py b/qiskit_ibm_runtime/__init__.py
@@ -196,7 +196,6 @@
    IBMBackend
    RuntimeJob
    RuntimeJobV2
-   RuntimeOptions
    RuntimeEncoder
    RuntimeDecoder
 """

diff --git a/qiskit_ibm_runtime/estimator.py b/qiskit_ibm_runtime/estimator.py
@@ -334,7 +334,6 @@ def run(  # pylint: disable=arguments-differ
             parameter_values: Concrete parameters to be bound.
 
             **kwargs: Individual options to overwrite the default primitive options.
-                These include the runtime options in :class:`qiskit_ibm_runtime.RuntimeOptions`.
 
         Returns:
             Submitted job.
@@ -370,7 +369,6 @@ def _run(  # pylint: disable=arguments-differ
             parameter_values: An optional list of concrete parameters to be bound.
 
             **kwargs: Individual options to overwrite the default primitive options.
-                These include the runtime options in :class:`~qiskit_ibm_runtime.RuntimeOptions`.
 
         Returns:
             Submitted job

diff --git a/qiskit_ibm_runtime/fake_provider/local_service.py b/qiskit_ibm_runtime/fake_provider/local_service.py
@@ -154,7 +154,6 @@ def run(
             inputs: Program input parameters. These input values are passed
                 to the runtime program.
             options: Runtime options that control the execution environment.
-                See :class:`RuntimeOptions` for all available options.
 
         Returns:
             A job representing the execution.

diff --git a/qiskit_ibm_runtime/qiskit_runtime_service.py b/qiskit_ibm_runtime/qiskit_runtime_service.py
@@ -804,7 +804,6 @@ def run(
             inputs: Program input parameters. These input values are passed
                 to the runtime program.
             options: Runtime options that control the execution environment.
-                See :class:`RuntimeOptions` for all available options.
 
             callback: Callback function to be invoked for any interim results and final result.
                 The callback function will receive 2 positional parameters:

diff --git a/qiskit_ibm_runtime/sampler.py b/qiskit_ibm_runtime/sampler.py
@@ -266,7 +266,6 @@ def run(  # pylint: disable=arguments-differ
                 a list of (parameterized) :class:`~qiskit.circuit.QuantumCircuit`.
             parameter_values: Concrete parameters to be bound.
             **kwargs: Individual options to overwrite the default primitive options.
-                These include the runtime options in :class:`qiskit_ibm_runtime.RuntimeOptions`.
 
         Returns:
             Submitted job.
@@ -296,7 +295,6 @@ def _run(  # pylint: disable=arguments-differ
                 a list of (parameterized) :class:`~qiskit.circuit.QuantumCircuit`.
             parameter_values: An optional list of concrete parameters to be bound.
             **kwargs: Individual options to overwrite the default primitive options.
-                These include the runtime options in :class:`qiskit_ibm_runtime.RuntimeOptions`.
 
         Returns:
             Submitted job.

diff --git a/qiskit_ibm_runtime/session.py b/qiskit_ibm_runtime/session.py
@@ -178,7 +178,6 @@ def run(
             inputs: Program input parameters. These input values are passed
                 to the runtime program.
             options: Runtime options that control the execution environment.
-                See :class:`qiskit_ibm_runtime.RuntimeOptions` for all available options.
             callback: Callback function to be invoked for any interim results and final result.
 
         Returns: