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

Improve documentation on the distinction between a (synced) JSONDict and a dict #39

Open
csadorf opened this issue Jul 19, 2019 · 0 comments

Comments

@csadorf
Copy link
Contributor

csadorf commented Jul 19, 2019

We need to clarify that the synchronized JSONDict data structure underlying for example a Job.statepoint or a Job.document is similar to, but not the same as a Python dict. This is especially important when it comes to the conversion to a dict and subsequent manipulation which can lead to some confusion as demonstrated in this issue.

I suggest to add highly visible warnings and links to respective sections wherever we introduce the data structure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant