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

Fixed Incoherent notation for the RZX Gate api doc #12754

Merged
merged 3 commits into from
Oct 1, 2024

Conversation

Ameya28Bhave
Copy link
Contributor

Summary

Fixes #12684

Fixed the issue of notation for the RZX gate. The example section of the api document has been updated and follows the big-endian format. For example now the notation is showed as $R_{ZX}(\theta = 0)\ q_0, q_1 = I$ .

@Ameya28Bhave Ameya28Bhave requested a review from a team as a code owner July 10, 2024 22:38
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Jul 10, 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

@CLAassistant
Copy link

CLAassistant commented Jul 10, 2024

CLA assistant check
All committers have signed the CLA.

The default notation for RZX gate was in big-endian and the example shown was in little-endian format.
Fix is done in the example section where the gate notation is concatenated with q_0 , q_1 and
big-endian format is followed throughout.
For example intial notation was :
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For example intial notation was :
For example initial notation was :

Copy link
Contributor

@Cryoris Cryoris 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 the fix!

As side note, I'm not sure this notation of <gate> q0 q1 = <some matrix> is slightly abusive notation and we might want to fix this at some point (not in this PR!)

Copy link
Contributor

Choose a reason for hiding this comment

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

We don't typically write release notes for doc fixes, you can just delete this file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will do. Thanks for the review @Cryoris

Copy link
Contributor

@Shivansh20128 Shivansh20128 left a comment

Choose a reason for hiding this comment

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

I think its fine now. Congrats on your first issue!

@Cryoris
Copy link
Contributor

Cryoris commented Sep 25, 2024

@Shivansh20128 the release note is not yet deleted, that's still outstanding 🙂

@Shivansh20128
Copy link
Contributor

@Shivansh20128 the release note is not yet deleted, that's still outstanding 🙂

Oh yeah right. Sorry for the oversight.

Cryoris
Cryoris previously approved these changes Oct 1, 2024
@Cryoris Cryoris enabled auto-merge October 1, 2024 11:21
@Cryoris Cryoris added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Oct 1, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 11124263805

Details

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

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 1 92.48%
crates/qasm2/src/parse.rs 12 96.69%
Totals Coverage Status
Change from base Build 11121834647: -0.001%
Covered Lines: 74136
Relevant Lines: 83422

💛 - Coveralls

@Cryoris Cryoris added this pull request to the merge queue Oct 1, 2024
Merged via the queue into Qiskit:main with commit 54139be Oct 1, 2024
15 checks passed
ElePT pushed a commit to ElePT/qiskit that referenced this pull request Oct 3, 2024
* Fixed Incoherent notation for the RZX Gate api doc

* Delete reno

---------

Co-authored-by: Julien Gacon <[email protected]>
ElePT pushed a commit to ElePT/qiskit that referenced this pull request Oct 7, 2024
* Fixed Incoherent notation for the RZX Gate api doc

* Delete reno

---------

Co-authored-by: Julien Gacon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog Community PR PRs from contributors that are not 'members' of the Qiskit repo documentation Something is not clear or an error documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Incoherence in notation for RZX gate
7 participants