Remove discussion about user's compute env from knitting docs #570
Conversation
This file contains 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
caleb-johnson
added
documentation
Pull Request Test Coverage Report for Build 8897298287Details
💛 - Coveralls |
caleb-johnson
commented
Apr 29, 2024
|
|
||
| The toolbox currently contains the following tools: | ||
| - Circuit Cutting [[1-6]](#references) | ||
|
|
||
|
|
||
| For a more detailed discussion on circuit cutting, check out our [technical guide](https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/explanation/index.html#overview-of-circuit-cutting). |
There was a problem hiding this comment.
I think we're slowly moving toward this being a circuit cutting repo, so I think it's fine to slip this very nice document in on our main docs pages
caleb-johnson
commented
Apr 29, 2024
| This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy <https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md>`_. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. | ||
| For a more detailed discussion on circuit cutting, check out our `technical guide <https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/explanation/index.html#overview-of-circuit-cutting>`__. | ||
|
|
||
| This project is meant to evolve rapidly and, as such, does not follow `Qiskit's deprecation policy <https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md>`__. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the :ref:`release notes`. |
There was a problem hiding this comment.
Added an underscore to make the __ used elsewhere in this doc. It only had one underscore before (probably fine)
There was a problem hiding this comment.
Yeah, it's fine except when it's not and breaks Sphinx. 😅. better to have two underscores everywhere when we think of it.
garrison
reviewed
Apr 30, 2024
garrison
previously approved these changes
Apr 30, 2024
Co-authored-by: Jim Garrison <[email protected]>
Link's working in the CI artifact. Should be good to merge. Thanks |
mergify bot
pushed a commit
that referenced
this pull request
Apr 30, 2024
* Remove discussion about user's compute env from knitting docs * revert deletion in index.rat * link to explanatory * Add blurb to docs/index * fix link * Update docs/index.rst Co-authored-by: Jim Garrison <[email protected]> --------- Co-authored-by: Jim Garrison <[email protected]> (cherry picked from commit e6a49dc)
garrison
pushed a commit
that referenced
this pull request
Apr 30, 2024
…571) * Remove discussion about user's compute env from knitting docs * revert deletion in index.rat * link to explanatory * Add blurb to docs/index * fix link * Update docs/index.rst Co-authored-by: Jim Garrison <[email protected]> --------- Co-authored-by: Jim Garrison <[email protected]> (cherry picked from commit e6a49dc) Co-authored-by: Caleb Johnson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #546