Updates to service docstring #2379
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR suggests a series of improvements to the
QiskitRuntimeService
docstring to increase transparency on how the service should be instantiated:Details and comments
This documentation update is related to the improvements suggested in Selection of instance enhancements #2374, where I think they would benefit from an overall clearer docstring.
This PR partially conflicts with Update instance selection behavior #2375, whichever is merged second should make sure to incorporate the instance selection changes to this new docstring.