Skip to content

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

phalakbh
Copy link
Contributor

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 when qubits and parameters 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.

@phalakbh phalakbh requested a review from a team as a code owner July 21, 2025 12:16
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Jul 21, 2025
@qiskit-bot
Copy link
Collaborator

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:

  • @Qiskit/terra-core

@coveralls
Copy link

coveralls commented Jul 21, 2025

Pull Request Test Coverage Report for Build 16505924737

Warning: 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

  • 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
  • 76 unchanged lines in 5 files lost coverage.
  • Overall coverage decreased (-0.03%) to 87.747%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 2 92.53%
crates/transpiler/src/passes/elide_permutations.rs 3 94.92%
crates/transpiler/src/passes/gate_direction.rs 11 96.05%
crates/qasm2/src/parse.rs 12 97.09%
crates/transpiler/src/target/mod.rs 48 84.99%
Totals Coverage Status
Change from base Build 16406114169: -0.03%
Covered Lines: 81426
Relevant Lines: 92796

💛 - Coveralls

@raynelfss raynelfss added documentation Something is not clear or an error documentation Intern PR PR submitted by IBM Quantum interns mod: transpiler Issues and PRs related to Transpiler and removed Community PR PRs from contributors that are not 'members' of the Qiskit repo labels Jul 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation Intern PR PR submitted by IBM Quantum interns mod: transpiler Issues and PRs related to Transpiler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ASAPScheduleAnalysis Yields a TranspilerError given InstructionDurations
4 participants