Skip to content
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

Transpiler: Singleton and List description in docstring now reflected in type hinting #8814

Closed
wants to merge 6 commits into from

Conversation

Eriken79
Copy link

Summary

The docstring in qiskit-terra/qiskit/compiler/transpiler.py specified that a singleton or list version of each of the parameters could be passed to the circuits. The type hinting only reflected the singleton aspect. I cleaned up the naming by giving aliases to some of the longer type hints and made sure the list version of the parameter was represented in each type hint.

Details and comments

I don't believe that I need to use reno to document these changes, but if it is necessary just reject the request with a comment about reno and I can update it.

@Eriken79 Eriken79 requested a review from a team as a code owner September 30, 2022 05:32
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Sep 30, 2022
@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 the following people are requested to review this:

  • @Qiskit/terra-core

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@kevinhartman
Copy link
Contributor

Thanks for the PR! Coincidentally, we're actually in the process of deprecating the broadcasting behavior of this interface, i.e. removing the list variants of these parameters. This is being done in #8835.

From that PR, it sounds like we might rather leave the type hints in their current incomplete state. Feel free to comment on the PR if you'd like to weigh in 😄.

@jakelishman
Copy link
Member

Closing due to above discussion; we're moving in a different way on this. Thank you for the interest in contributing, though!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community PR PRs from contributors that are not 'members' of the Qiskit repo
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants