DOCSP-46694 - Extended JSON #169
Conversation
✅ Deploy Preview for docs-pymongo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| You can write an Extended JSON string from a list of dictionaries | ||
| by calling the ``bson.json_util.dumps()`` method. | ||
| In this example, we output the Extended JSON in the Relaxed mode format. |
There was a problem hiding this comment.
Is it expected that a user will know what "Relaxed format" is when reading this, or should we provide a brief description?
There was a problem hiding this comment.
Our other docs have more info on the formats (see the Java page I linked earlier), but I thought it was redundant to the Server manual, so I just went with a link.
One option is to the move the link higher in the page and make it more visible?
There was a problem hiding this comment.
Makes sense. Yeah I think making the link more visible and closer to the first mention would be helpful. Maybe linking it inline on first mention (although I know we don't do that often) or just adding a "To learn more about..." somewhere closer
Co-authored-by: Jordan Smith <[email protected]>
| }}} | ||
| ]''' | ||
|
|
||
| By default, the ``dumps()`` method returns the Extended JSON string in the Relaxed |
There was a problem hiding this comment.
What is the Relaxed format? Would users be reasonably expected to know what that means without prior exposure?
There was a problem hiding this comment.
I tried to keep this page focused on just the PyMongo aspects of it to avoid redundancy with the server docs (linked on this page). That said, both you and the docs reviewer asked whether this page should include background info on the format, which makes me think we should 😃
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a)
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a)
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a)
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a)
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a)
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a) Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a) Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a) Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a) Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]> (cherry picked from commit fe2c41a) Co-authored-by: Mike Woofter <[email protected]>
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-46694
Staging Links
Self-Review Checklist