documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Improve documentation on Registers and Qubits

Open shraddha-aangiras opened this issue 1 year ago • 6 comments

Based on user feedback from the Qiskit Slack, I added more explanations of commonly used methods and attributes of circuits. In particular:

  • explained how to extract information from circuits
  • added information on creating and managing registers
  • added information measuring circuits fixes #1469

shraddha-aangiras avatar Jun 27 '24 13:06 shraddha-aangiras

Thanks for contributing to Qiskit documentation!

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. Thanks! 🙌

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

  • @frankharkins

qiskit-bot avatar Jun 27 '24 13:06 qiskit-bot

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@shraddha-aangiras we've recently edited the history on main, can you please reset your branch using the following commands.

# Make sure you're on your branch
git switch improvedocs-issue1469
# Overwrite your branch with our history
git reset --hard origin/main
# re-apply your commits on top of the new history
git cherry-pick c370ad180de77c0b816dc025dd719806112f753a  361ac3ffb84190f25930a9c6a94819f4eb058c9f
# Check everything looks correct
git diff main
# If all good, force-push to your branch
git push --force

Let me know if you have any questions. Sorry for the inconvenience.

frankharkins avatar Jul 22 '24 15:07 frankharkins

@frankharkins No problem, will get that along with the suggested changes (thanks @javabster!) fixed by tomorrow

shraddha-aangiras avatar Jul 24 '24 12:07 shraddha-aangiras

@frankharkins can you let me know if I did it right? Thanks!

shraddha-aangiras avatar Aug 04 '24 10:08 shraddha-aangiras

Thanks @beckykd @kaelynj, made the changes you suggested :)

shraddha-aangiras avatar Aug 06 '24 05:08 shraddha-aangiras

@shraddha-aangiras do you think you can finish this PR? Alternatively, we can close and re-open in a fresh PR.

abbycross avatar Jul 31 '25 14:07 abbycross

Moved to #3989

kaelynj avatar Sep 29 '25 15:09 kaelynj