DOCSP-45358: documents #67
Conversation
✅ Deploy Preview for docs-mongoid ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| {+odm+}. The ``Document`` module is a representation of a MongoDB | ||
| document. To learn more about the terminology, structure, and limitations of |
There was a problem hiding this comment.
| {+odm+}. The ``Document`` module is a representation of a MongoDB | |
| document. To learn more about the terminology, structure, and limitations of | |
| {+odm+}. The ``Document`` module represents a MongoDB | |
| document. To learn more about the terminology, structure, and limitations of |
| MongoDB Representation | ||
| ---------------------- | ||
|
|
||
| The representation of a ``Document`` in MongoDB is a BSON object that is |
There was a problem hiding this comment.
| The representation of a ``Document`` in MongoDB is a BSON object that is | |
| A ``Document`` in MongoDB is represented by a BSON object that is |
|
|
||
| The representation of a ``Document`` in MongoDB is a BSON object that is | ||
| similar to a {+language+} hash or JSON object. You can store instances | ||
| of your models directly in a collection in the database, or you can |
There was a problem hiding this comment.
| of your models directly in a collection in the database, or you can | |
| of your models directly in a collection, or you can |
or "database collection"?
|
|
||
| You must include the ``Mongoid::Document`` module in any class that you | ||
| want to persist to MongoDB. By including the ``Document`` module in your | ||
| model class, you can use its methods on instances of your model class. |
There was a problem hiding this comment.
soft S: include a reference here to the below section on using a Document method
| You can find more information about the ``Document`` module in the `API | ||
| documentation <{+api-root+}/Document.html>`__. | ||
|
|
||
| MongoDB Representation |
There was a problem hiding this comment.
S: in my opinion, main focus of this section is an example on using the .create() method - might be worth changing the title to reflect that.
And/or, the representation paragraph kinda feels like it splits apart the section about the Document class and its methods. Some alternatives could be moving the below method example to the preceding section (and leaving this title as is), or putting the representation paragraph into an admonition.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-45358
Staging - https://deploy-preview-67--docs-mongoid.netlify.app/data-modeling/documents/
Self-Review Checklist