Skip to content

DOCSP-46701: Serialization #168

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

Merged
merged 7 commits into from
Feb 10, 2025

Conversation

mcmorisi
Copy link
Collaborator

@mcmorisi mcmorisi commented Feb 7, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-46701

Staging Links

  • serialization
  • index
  • troubleshooting
  • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?

    Copy link

    netlify bot commented Feb 7, 2025

    Deploy Preview for docs-pymongo ready!

    Name Link
    🔨 Latest commit 654a84b
    🔍 Latest deploy log https://app.netlify.com/sites/docs-pymongo/deploys/67aa2de3185a2e000861447a
    😎 Deploy Preview https://deploy-preview-168--docs-pymongo.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Copy link
    Collaborator

    @stephmarie17 stephmarie17 left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM with a few comments ❇️

    Serializing Ordered Documents
    -----------------------------

    Because the key-value pairs in {+language+} dictionaries are unordered, the order of

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    All versions of Python we support use ordered dictionaries where the order of inserted keys determines the order of the dictionary. Is the behavior described here still occurring, or is it an artifact of older Python versions that still had unordered dictionaries?

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I grabbed the info from this FAQ page. However, I see that this page was pulled from PyMongo docs, which leads me to believe they haven't been updated in a while.

    Should I just remove this section completely?

    Copy link

    @NoahStapp NoahStapp Feb 10, 2025

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Ah, that makes sense. Yeah, that section of the troubleshooting FAQ should be removed for no longer being accurate.

    This whole section can be removed, yup!

    Custom Classes
    --------------

    To serialize and deserialize custom {+language+} classes, you must implement custom logic

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Does it make sense to explicitly call out that serialization and deserialization are required in order to work with custom data classes?

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    That was my intention with this sentence, but if you feel it's not clear enough I can make it more explicit.

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I think it's clear enough.

    @mcmorisi mcmorisi requested a review from NoahStapp February 10, 2025 16:48
    @mcmorisi mcmorisi merged commit 8079aa9 into mongodb:master Feb 10, 2025
    6 checks passed
    @mcmorisi mcmorisi deleted the DOCSP-46701-serialization branch February 10, 2025 17:59
    mcmorisi added a commit that referenced this pull request Feb 10, 2025
    (cherry picked from commit 8079aa9)
    mcmorisi added a commit that referenced this pull request Feb 10, 2025
    (cherry picked from commit 8079aa9)
    mcmorisi added a commit that referenced this pull request Feb 10, 2025
    (cherry picked from commit 8079aa9)
    mcmorisi added a commit that referenced this pull request Feb 10, 2025
    (cherry picked from commit 8079aa9)
    mcmorisi added a commit that referenced this pull request Feb 10, 2025
    (cherry picked from commit 8079aa9)
    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

    Successfully merging this pull request may close these issues.

    3 participants