-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Improve documentation for InstructionDurations
class
#14769
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…tribute and initialization descriptions
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the following people are relevant to this code:
|
Pull Request Test Coverage Report for Build 16505924737Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Summary
This PR improves the documentation for the
InstructionDurations
class with comprehensive documentation and clearer examples. The changes include a detailed class docstring explaining the three-tier lookup system (parameterized → qubit-specific → default), comprehensive__init__
documentation with practical examples showing all tuple formats, and explanations of whenqubits
andparameters
can be None to create fallback behaviors.Details and comments
Fixes #14691
I am still not too sure on how to get the
InstructionDurationType
alias to reflect the type hint as discussed in the issue, so for a start I have specified in the doc string within__init__
what each tuple in the list should look like, along with the data types.