Skip to content

Conversation

rustagir
Copy link
Contributor

@rustagir rustagir commented Nov 18, 2024

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

  • 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 Nov 18, 2024

Deploy Preview for docs-mongoid ready!

Name Link
🔨 Latest commit 9192fed
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongoid/deploys/673df8edb9d2110008732695
😎 Deploy Preview https://deploy-preview-67--docs-mongoid.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

@mayaraman19 mayaraman19 left a comment

Choose a reason for hiding this comment

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

Looks pretty good! Requesting changes mainly based on the page flow

Comment on lines 24 to 25
{+odm+}. The ``Document`` module is a representation of a MongoDB
document. To learn more about the terminology, structure, and limitations of
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{+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
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

reworded


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
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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 can find more information about the ``Document`` module in the `API
documentation <{+api-root+}/Document.html>`__.

MongoDB Representation
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

moved the text around/reworded

@rustagir rustagir requested a review from mayaraman19 November 20, 2024 14:58
Copy link
Collaborator

@mayaraman19 mayaraman19 left a comment

Choose a reason for hiding this comment

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

LGTM!

To learn more about how to model your data by using {+odm+} models,
see the :ref:`mongoid-data-modeling` guides.

.. TODO Add link to field types guide.
Copy link
Collaborator

Choose a reason for hiding this comment

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

i'm assuming this guide hasn't been created yet, but pointing this out just in case it has!

@rustagir rustagir merged commit 4d87c40 into mongodb:standardized Nov 20, 2024
5 checks passed
@rustagir rustagir mentioned this pull request Nov 20, 2024
5 tasks
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