Skip to content
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 9 commits into from Aug 10, 2021

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Aug 9, 2021

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.

@balopat balopat requested review from cduck, vtomole and a team as code owners August 9, 2021 22:01
@balopat balopat requested a review from dstrain115 August 9, 2021 22:01
@google-cla google-cla bot added the cla: yes Makes googlebot stop complaining. label Aug 9, 2021
Copy link
Collaborator

@mpharrigan mpharrigan left a 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

docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/modules.md Outdated Show resolved Hide resolved
docs/dev/serialization.md Outdated Show resolved Hide resolved
docs/dev/serialization.md Outdated Show resolved Hide resolved
docs/dev/serialization.md Outdated Show resolved Hide resolved
@balopat balopat changed the title updating json serialization docs + adding module docs update json serialization docs + add module docs Aug 10, 2021
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 10, 2021
@CirqBot 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 CirqBot merged commit 8c505fb into quantumlib:master Aug 10, 2021
@CirqBot 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
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JSON serialization docs are out of date
3 participants