Execution span docs #1918
Merged
Execution span docs #1918
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ihincks
commented
Sep 11, 2024
Eric-Arellano
approved these changes
Sep 11, 2024
There was a problem hiding this comment.
Yeah this should be fine Python-wise and documentation-wise. Previous importers of qiskit_ibm_runtime.execution_spans now will import via execution_spans/__init__.py rather than execution_spans.py - that shouldn't matter to them.
I did not review the actual code itself, so I'm assuming things did not change from before.
ihincks
added a commit
to ihincks/qiskit-ibm-runtime
that referenced
this pull request
Sep 11, 2024
* Make execution_span a composite module and add docs * add to sphinx * lint * add module docstrings
ihincks
added a commit
that referenced
this pull request
Sep 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 adds the execution span classes to the docs. It also turns the
execution_spanmodule into a composite module where each class is broken out into its own file. My understanding is that this will not affect downstream unless they are doing wacky stuff.