A Cauldron of Doc fixes #5680
Merged
A Cauldron of Doc fixes #5680
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
- Change Foxtail to Sycamore since Foxtail is deprecated. - Add some clarification that instructions are for linux.
Miscellaneous doc fixes around cirq - Fix indenting where it is inappropriately detected as blockquotes - Fix references and commas at a few places. - Move some docstrings from init to class so that they show up on the API reference properly. - Fix list formatting - Fix one-line summaries that are more than one line.
dstrain115
requested review from
a team,
vtomole,
cduck,
wcourtney and
verult
as code owners
dabacon
approved these changes
Jul 8, 2022
| $\sum tensor_{i_0,...,i_{r-1},j_0,...,j_{r-1}} * | ||
| More specifically, this computes: | ||
|
|
||
| $$i |
| Calibration objects instead of using this directly. | ||
| """Client for the Quantum Engine API handling protos and gRPC client. | ||
|
|
||
| Thie is the client for the Quantum Engine API that deals with the engine protos |
| served by using the `Engine`, `EngineProgram`, `EngineJob`, `EngineProcessor`, and | ||
| `Calibration` objects instead of using this directly. | ||
|
|
||
| Args: |
There was a problem hiding this comment.
does this render correctly on doc site? I thought you should keep the args in the init but put a description on the class for the best redering?
There was a problem hiding this comment.
Changed to this style.
dstrain115
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
automerge
rht
pushed a commit
to rht/Cirq
that referenced
this pull request
May 1, 2023
Miscellaneous doc fixes around cirq
- Fix indenting where it is inappropriately detected as blockquotes
- Fix references and commas at a few places.
- Move some docstrings from init to class so that they show up on
the API reference properly.
- Fix list formatting
- Fix one-line summaries that are more than one line.
harry-phasecraft
pushed a commit
to PhaseCraft/Cirq
that referenced
this pull request
Oct 31, 2024
Miscellaneous doc fixes around cirq
- Fix indenting where it is inappropriately detected as blockquotes
- Fix references and commas at a few places.
- Move some docstrings from init to class so that they show up on
the API reference properly.
- Fix list formatting
- Fix one-line summaries that are more than one line.
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.
Miscellaneous doc fixes around cirq
- Fix indenting where it is inappropriately detected as blockquotes
- Fix references and commas at a few places.
- Move some docstrings from init to class so that they show up on
the API reference properly.
- Fix list formatting
- Fix one-line summaries that are more than one line.