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.

Sign up for GitHub

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

Jump to bottom

JSON serialization docs are out of date #4376

Closed
mpharrigan opened this issue Aug 2, 2021 · 1 comment · Fixed by #4397
Closed

JSON serialization docs are out of date #4376

mpharrigan opened this issue Aug 2, 2021 · 1 comment · Fixed by #4397
Assignees
@balopat
Labels
area/json kind/bug-report Something doesn't seem to work. triage/accepted there is consensus amongst maintainers that this is a real bug or a reasonable feature to add

Comments

@mpharrigan
Copy link
Collaborator

https://quantumai.google/cirq/dev/serialization is out of date

  • paths are wrong
  • resolver has been refactored into modules
  • I can't find where the list of "this shouldn't be serializable" has gone
  • list of modules available during repr evaluation is out of date
@mpharrigan mpharrigan added the kind/bug-report Something doesn't seem to work. label Aug 2, 2021
@mpharrigan mpharrigan changed the title https://quantumai.google/cirq/dev/serialization is out of date JSON serialization docs are out of date Aug 2, 2021
@balopat balopat self-assigned this Aug 3, 2021
@balopat balopat added the triage/accepted there is consensus amongst maintainers that this is a real bug or a reasonable feature to add label Aug 3, 2021
@balopat
Copy link
Contributor

balopat commented Aug 3, 2021

That's my bad - I should rework the docs after all the rework.

@balopat balopat mentioned this issue Aug 9, 2021
Merged
CirqBot pushed a commit that referenced this issue Aug 10, 2021
@balopat
update json serialization docs + add module docs (#4397)
8c505fb 
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.
rht pushed a commit to rht/Cirq that referenced this issue May 1, 2023
@balopat @rht
update json serialization docs + add module docs (quantumlib#4397)
ec8a6f1 
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
Assignees

@balopat balopat

Labels
area/json kind/bug-report Something doesn't seem to work. triage/accepted there is consensus amongst maintainers that this is a real bug or a reasonable feature to add
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

update json serialization docs + add module docs balopat/Cirq
2 participants
@balopat @mpharrigan