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

DOCSP-46310 EnumRepresentationConvention constructor update #448

Merged

Conversation

jordan-smith721
Copy link
Collaborator

@jordan-smith721 jordan-smith721 commented Jan 29, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • whats-new
  • 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 Jan 29, 2025

    Deploy Preview for docs-csharp ready!

    Name Link
    🔨 Latest commit 7eb4e7c
    🔍 Latest deploy log https://app.netlify.com/sites/docs-csharp/deploys/67a621059ed1520008011dd0
    😎 Deploy Preview https://deploy-preview-448--docs-csharp.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.

    Comment on lines 44 to 47
    - Adds a new ``ObjectSerializerAllowedTypesConvention`` convention pack that
    allows you to specify which types are allowed to be serialized and
    deserialized by the object serializer. To learn more about convention packs,
    see the :ref:`csharp-convention-packs` guide.
    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    Note for reviewer: This section is already reviewed/approved in a separate PR (to be merged before this one)

    Copy link
    Collaborator

    @mcmorisi mcmorisi 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 small thing!

    Comment on lines 49 to 52
    - Adds a new constructor for the ``EnumRepresentationConvention`` class that
    allows you use the ``topLevelOnly`` parameter to specify whether the
    convention applies to only enum properties or to all properties that include
    collections of enums, such as lists, arrays, and dictionaries.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Sentence feels like it runs a touch long so I cut the ending off (with the assumption that people reading this would understand what a collection is). Feel free to workshop.

    Suggested change
    - Adds a new constructor for the ``EnumRepresentationConvention`` class that
    allows you use the ``topLevelOnly`` parameter to specify whether the
    convention applies to only enum properties or to all properties that include
    collections of enums, such as lists, arrays, and dictionaries.
    - Adds a new constructor for the ``EnumRepresentationConvention`` class that
    allows you use the ``topLevelOnly`` parameter to specify whether the
    convention applies to only enum properties or to all properties that include
    collections of enums.

    @jordan-smith721 jordan-smith721 merged commit 9cbe8d1 into mongodb:master Feb 7, 2025
    6 checks passed
    @jordan-smith721 jordan-smith721 deleted the DOCSP-46310-enum-rep-update branch February 7, 2025 15:10
    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.

    2 participants