Show missing type hints & inline class base class in API docs (backport #13483) #13516
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
* Show missing type hints & inline class values in API docs * Fix fmt, oops * Fix density matrix use of Circuit (cherry picked from commit cc30af5)
|
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:
|
github-actions
bot
added
documentation
Pull Request Test Coverage Report for Build 12122770821Details
💛 - Coveralls |
raynelfss
approved these changes
Dec 2, 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.
The API docs were leaving off some important information:
.. autoclass::on a module page; it was already fine for.. autosummary::.None. These type hints are useful.To land this PR, I had to make a fix similar to #10772 to fix ambiguous type hints.
I also set up aliases for the extremely long types for
EstimatorPubLikeandSamplerPubLike. See Qiskit/qiskit-ibm-runtime#1877 for more context on that problem.This is an automatic backport of pull request #13483 done by Mergify.