DOCSP-26552 - polymorphism #143
Conversation
There was a problem hiding this comment.
Carefully reviewed all Vale errors in this file (ignored other files for now) and didn't see a way to avoid them that's clear, concise, and grammatical. Style Guide rationale for avoiding subjunctive mood (avoiding uncertainty) also doesn't apply here. Open to suggestions, though!
| If you're creating a class map manually, call the | ||
| ``BsonClassMap.RegisterClassMap<T>()`` method for every class in the hierarchy, as shown | ||
| in the following example: |
There was a problem hiding this comment.
You could include a link to the Class Mapping page here.
| Suppose you created an instance of the example ``Animal`` class and each of its | ||
| subclasses. If you serialized these objects to a single collection, the {+driver-short+} | ||
| would apply the ``ScalarDiscriminatorConvention`` and the corresponding | ||
| BSON documents would appear as follows: |
There was a problem hiding this comment.
I agree that what you've written here is fine, but to get around Vale you could change it to present tense:
| Suppose you created an instance of the example ``Animal`` class and each of its | |
| subclasses. If you serialized these objects to a single collection, the {+driver-short+} | |
| would apply the ``ScalarDiscriminatorConvention`` and the corresponding | |
| BSON documents would appear as follows: | |
| Suppose you create an instance of the example ``Animal`` class and each of its | |
| subclasses. If you serialize these objects to a single collection, then the | |
| {+driver-short+} applies the ``ScalarDiscriminatorConvention`` and the corresponding | |
| BSON documents appear as follows: |
There was a problem hiding this comment.
I thought about this formation a lot last night and whether it was strictly grammatical, or whether it should be "If you were to serialize..." and so on. But this is definitely readable and simplifies the sentence so I'm down with it
| { | ||
| } | ||
|
|
||
| If you're creating a class map manually, call the ``SetIsRootClass()`` method and pass |
There was a problem hiding this comment.
You've used this consistently, I just want to confirm that the method is SetIsRootClass(), rather than SetAsRootClass().
There was a problem hiding this comment.
Yep. Thanks for checking
| Suppose you labeled the example ``Animal`` class as the root of the inheritance hierarchy, | ||
| and then created an instance of the ``Animal`` class and each of its | ||
| subclasses. If you serialized these objects to a single collection, the {+driver-short+} | ||
| would apply the ``HierarchicalDiscriminatorConvention`` and the corresponding | ||
| BSON documents would appear as follows: |
There was a problem hiding this comment.
Use present tense again to avoid Vale:
| Suppose you labeled the example ``Animal`` class as the root of the inheritance hierarchy, | |
| and then created an instance of the ``Animal`` class and each of its | |
| subclasses. If you serialized these objects to a single collection, the {+driver-short+} | |
| would apply the ``HierarchicalDiscriminatorConvention`` and the corresponding | |
| BSON documents would appear as follows: | |
| Suppose you labele the example ``Animal`` class as the root of the inheritance hierarchy, | |
| and then create an instance of the ``Animal`` class and each of its | |
| subclasses. If you serialize these objects to a single collection, the {+driver-short+} | |
| applies the ``HierarchicalDiscriminatorConvention`` and the corresponding | |
| BSON documents appear as follows: |
|
|
||
| If you're working with data that doesn't follow the conventions used by the | ||
| {+driver-short+}--for example, data inserted into MongoDB by another driver or object | ||
| mapper--you might need to use a different value for your discriminator field to |
There was a problem hiding this comment.
I don't know how to rewrite this one - I prefer "might" to "may" and I don't actually see where in the style guide this is written as a rule.
There was a problem hiding this comment.
yeah, "must" doesn't have a direct subjunctive equivalent. leaving as is
(cherry picked from commit 139fe47)
(cherry picked from commit 139fe47)
(cherry picked from commit 139fe47)
(cherry picked from commit 139fe47)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-26552
Staging - https://preview-mongodbmongokart.gatsbyjs.io/csharp/docsp-26552-polymorphism/fundamentals/data-formats/polymorphism/
Self-Review Checklist