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

Fix CPhaseGate parameter name mismatch in API docs #13242

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

Conversation

cameron-d28
Copy link
Contributor

@cameron-d28 cameron-d28 commented Sep 30, 2024

Summary

fixes #11809

Details and comments

@cameron-d28 cameron-d28 requested a review from a team as a code owner September 30, 2024 11:25
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Sep 30, 2024
@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:

  • @Cryoris
  • @Qiskit/terra-core
  • @ajavadia

@cameron-d28 cameron-d28 marked this pull request as draft September 30, 2024 11:32
@coveralls
Copy link

coveralls commented Sep 30, 2024

Pull Request Test Coverage Report for Build 11167381278

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 11 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.009%) to 88.864%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 5 91.98%
crates/qasm2/src/parse.rs 6 96.69%
Totals Coverage Status
Change from base Build 11161049152: -0.009%
Covered Lines: 74318
Relevant Lines: 83631

💛 - Coveralls

Copy link
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this!

In the same file, we seem to have the same discrepancy between the argument name and the documented symbol in PhaseGate - would you be able to swap that over to be consistent as well?

@cameron-d28
Copy link
Contributor Author

yes i will check this out. i had a question about notation i asked on the issue. it seems like changing the notation to theta rather than parameter to lambda is correct?

@cameron-d28
Copy link
Contributor Author

i realized that the notation should be changed since the parameters are inferred from Controlled Gate

@cameron-d28
Copy link
Contributor Author

@jakelishman later today or early am tomorrow. i can take a second to look for any more incorrect notation.

@Eric-Arellano Eric-Arellano added the documentation Something is not clear or an error documentation label Sep 30, 2024
@cameron-d28
Copy link
Contributor Author

cameron-d28 commented Oct 1, 2024

should RZ gate be updated to change lambda in notation to match phi in parameters?

@cameron-d28 cameron-d28 marked this pull request as ready for review October 3, 2024 15:54
@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:

  • @Cryoris
  • @Qiskit/terra-core
  • @ajavadia

@Eric-Arellano
Copy link
Collaborator

Thanks, Cameron! It looks like there is a merge conflict in qiskit/circuit/library/standard_gates/u1.py

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 documentation Something is not clear or an error documentation
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

CPhaseGate parameter name mismatch in API docs
5 participants