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
update json serialization docs + add module docs #4397
Merged
Merged
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
mpharrigan
approved these changes
Aug 9, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bunch of wording/organizational suggestions.
The one required fix is the bad path to cirq/protocols/json.py instead of new resolver cache files. All else is optional.
Marking as approved, but ping me if you'd like to give it another pass after making changes
balopat
changed the title
updating json serialization docs + adding module docs
update json serialization docs + add module docs
Aug 10, 2021
balopat
requested review from
ColemanCollins,
dabacon,
gmauricio,
HGSilveri,
ma5x,
nakardo,
pschindler and
wcourtney
as code owners
August 10, 2021 04:19
balopat
added
the
automerge
Tells CirqBot to sync and merge this PR. (If it's running.)
label
Aug 10, 2021
CirqBot
added
the
front_of_queue_automerge
CirqBot uses this label to indicate (and remember) what's being merged next.
label
Aug 10, 2021
CirqBot
removed
automerge
Tells CirqBot to sync and merge this PR. (If it's running.)
front_of_queue_automerge
CirqBot uses this label to indicate (and remember) what's being merged next.
labels
Aug 10, 2021
rht
pushed a commit
to rht/Cirq
that referenced
this pull request
May 1, 2023
Adds docs for modules and updates the JSON serialization documentation. Also removes the need for modifying the `imports` dict in the repr eval test, instead it automates the creation of it. Hat tip to @erichulburd for starting the new version of the JSON serialization docs in https://github.com/quantumlib/Cirq/pull/4378/files. Fixes quantumlib#4376.
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.
Adds docs for modules and updates the JSON serialization documentation.
Also removes the need for modifying the
imports
dict in the repr eval test, instead it automates the creation of it.Hat tip to @erichulburd for starting the new version of the JSON serialization docs in https://github.com/quantumlib/Cirq/pull/4378/files.
Fixes #4376.