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

README.md typo & manual QA #13669

Merged
merged 2 commits into from
Jan 16, 2025
Merged

README.md typo & manual QA #13669

merged 2 commits into from
Jan 16, 2025

Conversation

Cryoris
Copy link
Contributor

@Cryoris Cryoris commented Jan 15, 2025

Summary

Fix a typo and apply some manual quality assurance such that the example code matches our formatting. Also "primitive functions" are rather referred to as primitives (see e.g. https://docs.quantum.ibm.com/api/qiskit/primitives), it would be nice to be a bit more consistent.

@Cryoris Cryoris added the Changelog: None Do not include in changelog label Jan 15, 2025
@Cryoris Cryoris requested a review from a team as a code owner January 15, 2025 15:15
@qiskit-bot
Copy link
Collaborator

One or more of the following people are relevant to this code:

  • @Qiskit/terra-core

@coveralls
Copy link

coveralls commented Jan 15, 2025

Pull Request Test Coverage Report for Build 12805552412

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 10 unchanged lines in 2 files lost coverage.
  • Overall coverage remained the same at 88.923%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 4 92.23%
crates/qasm2/src/parse.rs 6 97.62%
Totals Coverage Status
Change from base Build 12790871540: 0.0%
Covered Lines: 79442
Relevant Lines: 89338

💛 - Coveralls

Copy link
Contributor

@ElePT ElePT left a comment

Choose a reason for hiding this comment

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

LGTM, I added a few minor suggestions, but I am doubting the use of "Sampler" vs "the Sampler".... I don't know if we will ever achieve consistency :)

README.md Outdated Show resolved Hide resolved

Create an example quantum circuit using the `QuantumCircuit` class:

```python
import numpy as np
from qiskit import QuantumCircuit

# 1. A quantum circuit for preparing the quantum state |000> + i |111>
qc_example = QuantumCircuit(3)
qc_example.h(0) # generate superpostion
Copy link
Contributor

Choose a reason for hiding this comment

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

haha superpostion, it sounds like a superhero name

README.md Outdated Show resolved Hide resolved
Co-authored-by: Elena Peña Tapia <[email protected]>
Copy link
Contributor

@ElePT ElePT left a comment

Choose a reason for hiding this comment

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

LGTM

@ElePT ElePT added this pull request to the merge queue Jan 16, 2025
Merged via the queue into Qiskit:main with commit 39db0c7 Jan 16, 2025
17 checks passed
@Cryoris
Copy link
Contributor Author

Cryoris commented Jan 16, 2025

@Mergifyio backport stable/1.3

@Cryoris Cryoris deleted the qa-readme branch January 16, 2025 12:03
@alexanderivrii alexanderivrii added this to the 2.0.0 milestone Jan 16, 2025
Copy link
Contributor

mergify bot commented Jan 16, 2025

backport stable/1.3

✅ Backports have been created

@alexanderivrii alexanderivrii added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Jan 16, 2025
mergify bot pushed a commit that referenced this pull request Jan 16, 2025
* Put yourself in `black`s shoes and look at the readme

* Apply suggestions from code review

Co-authored-by: Elena Peña Tapia <[email protected]>

---------

Co-authored-by: Elena Peña Tapia <[email protected]>
(cherry picked from commit 39db0c7)
github-merge-queue bot pushed a commit that referenced this pull request Jan 16, 2025
* Put yourself in `black`s shoes and look at the readme

* Apply suggestions from code review

Co-authored-by: Elena Peña Tapia <[email protected]>

---------

Co-authored-by: Elena Peña Tapia <[email protected]>
(cherry picked from commit 39db0c7)

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 stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants