-
Notifications
You must be signed in to change notification settings - Fork 24
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-45822 Add convention packs section #447
DOCSP-45822 Add convention packs section #447
Conversation
✅ Deploy Preview for docs-csharp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
* - `IgnoreExtraElementsConvention <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.IgnoreExtraElementsConvention.html>`__ | ||
- Specifies whether to ignore extra elements in a document during deserialization. | ||
|
||
* - `ObjectSerializerAllowedTypesConvention <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ObjectSerializerAllowedTypesConvention.html>`__ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link will be broken until the API docs are released
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mostly lgtm, left a few comments for clarity improvments
---------------- | ||
|
||
Convention packs allow you to define and apply | ||
**conventions** to your classes and their members during serialization. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"during serialization"
Technically conventions are applied before serialization while auto configuring class maps.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the wording here. It was meant to convey that the conventions you specify are used/followed in the serialization process
|
||
The {+driver-short+} provides built-in convention packs that you can use to | ||
customize the serialization process. The following table describes some of the | ||
built-in convention packs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following are conventions, not convention-packs.
Convention-packs are sets of conventions that have been bundled to be used together.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarification. Updated the section to refer to conventions rather than convention packs in most instances
source/whats-new.txt
Outdated
|
||
The 3.2 driver release includes the following new features: | ||
|
||
- Adds a new ``ObjectSerializerAllowedTypesConvention`` convention pack that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ObjectSerializerAllowedTypesConvention is a convention, not a convention pack.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45822
Staging Links
Self-Review Checklist