Update "operators overview" page to highlight SparsePauliOp and split in-depth Operator coverage to separate page #1517
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Collaborator
|
thanks @kaelynj I'll take it from here |
Collaborator
|
I've made the following changes:
@javabster PTAL |
Contributor
|
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! 🙌 |
kevinsung
changed the title
javabster
reviewed
Jun 11, 2024
docs/build/operator-class.ipynb
Outdated
| "source": [ | ||
| "# The Operator class\n", | ||
| "\n", | ||
| "This page shows how to use the [`Operator`](/api/qiskit/qiskit.quantum_info.Operator) class. For a high-level overview of the class, see [Overview of operator classes](/build/operators-overview#operator)." |
Contributor
There was a problem hiding this comment.
Suggested change
| "This page shows how to use the [`Operator`](/api/qiskit/qiskit.quantum_info.Operator) class. For a high-level overview of the class, see [Overview of operator classes](/build/operators-overview#operator)." | |
| "This page shows how to use the [`Operator`](/api/qiskit/qiskit.quantum_info.Operator) class. For a high-level overview of the `quantum_info` module, including the `Operator` class and others, see [Operators module overview](/build/operators-overview)." |
I think this is a bit clearer, currently it's a bit vague to me about what is the difference between the 2 pages just from the intro description
Collaborator
There was a problem hiding this comment.
That page doesn't actually give an overview of the quantum_info module, only the operator classes. I've changed the sentence to
For a high-level overview of operator representations in Qiskit, including the
Operatorclass and others, see Overview of operator classes.
Collaborator
|
@javabster please take another look |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 19, 2024
Noticed a few edits to make in a [recent closed PR](#1517). - Changed "we" to "you" - avoided "will" when appropriate - replaced "may" with either "can" or "might" depending on context - general typo/punctuation/capitalization cleanup
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
… in-depth Operator coverage to separate page (Qiskit#1517) Closes Qiskit#1440 @kevinsung, here's what I have so far in terms of content to include. I think it might be worth mentioning the overloaded operators for the `SparsePauliOp` class and demonstrate some of the algebra that can be done. --------- Co-authored-by: Kevin J. Sung <kevjsung@umich.edu>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Noticed a few edits to make in a [recent closed PR](Qiskit#1517). - Changed "we" to "you" - avoided "will" when appropriate - replaced "may" with either "can" or "might" depending on context - general typo/punctuation/capitalization cleanup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1440
@kevinsung, here's what I have so far in terms of content to include. I think it might be worth mentioning the overloaded operators for the
SparsePauliOpclass and demonstrate some of the algebra that can be done.