Add developer doc explaining serialization #2548
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
dstrain115
approved these changes
Nov 14, 2019
docs/dev/serialization.md
Outdated
|
|
||
| When writing JSON, Cirq checks if the given object has a `_json_dict_` method. | ||
| If it does, the object is replaced by the output of that method. | ||
| Otherwise there are a series of several hardcoded cases for complex numbers, numpy arrays, sympy expressions, and a few others. |
There was a problem hiding this comment.
nit: I think it should be "Otherwise, there are..." with a comma.
| how to remove a serializable object from cirq while maintaing backwards compatibility with old serialized files, | ||
| and various related guidelines. | ||
|
|
||
| ## Exposed API |
There was a problem hiding this comment.
Optional: should there be a short background doc to explain why we want/need this?
mpharrigan
approved these changes
Nov 14, 2019
It line wraps at the end of sentences and also when the length gets too long. I wrote it in github's editor so I didn't have the 80 column guide. |
Strilanc
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
|
Automerge cancelled: A status check is failing. |
CirqBot
removed
automerge
Strilanc
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
the
automerge
CirqBot
removed
the
front_of_queue_automerge
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.
No description provided.