Skip to content

Commit

Permalink
Update private option docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
kt474 committed Dec 17, 2024
1 parent c6198f8 commit 779947a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion qiskit_ibm_runtime/options/environment_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ class EnvironmentOptions:
Default: ``None``.
"""
private: Optional[bool] = False
r"""Boolean value for marking jobs as private."""
r"""Boolean value for marking jobs as private. Private jobs do not have their job parameters
returned and job results can only be retrieved once. This option is only supported in the
``ibm_quantum`` channel."""

0 comments on commit 779947a

Please sign in to comment.