Skip to content

Conversation

rustagir
Copy link
Contributor

@rustagir rustagir commented Nov 4, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-44821
Staging - Starts at https://deploy-preview-61--docs-mongoid.netlify.app/interact-data/specify-query/#element-match

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? Some todos
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for docs-mongoid ready!

Name Link
🔨 Latest commit ca219dc
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongoid/deploys/6737b24e1e8ea900089540e6
😎 Deploy Preview https://deploy-preview-61--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
Contributor

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

Great work. Lots of small suggested changes, but nothing major.

@rustagir rustagir requested a review from mongoKart November 13, 2024 14:44
Copy link
Contributor

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

LGTM! A couple small comments to consider

Comment on lines 561 to 562
The ``find()`` method converts the ID that you pass to the
data type declared for the ``_id`` field in the model. By
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about this?

Suggested change
The ``find()`` method converts the ID that you pass to the
data type declared for the ``_id`` field in the model. By
When you pass an ID to the ``find()`` method, the method converts it
to the data type declared for the ``_id`` field in the model. By

Comment on lines 561 to 563
The ``find()`` method performs the type conversion of the argument that
you pass to the type declared for the ``_id`` field in the model. By
default, the ``_id`` field is defined as a ``BSON::ObjectId`` type.
Copy link
Contributor

Choose a reason for hiding this comment

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

This was still a little confusing because my brain wants to read "pass to" as a verbal phrase instead of verb + preposition, if that makes sense. What about:

"When you pass an ID to the find() method, it converts the ID to the data type..."


You can use the ``find_or_create_by()`` method to retrieve documents
based on the provided criteria. If no documents are found, it creates
and returns a newly persisted one.
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I meant the idea of persisting--that one's new to me.

Comment on lines 643 to 645
new one, without persisting it to MongoDB. The syntax for
``find_or_initialize_by()`` is the same for the ``find_or_create_by()``
method.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you need an "as" in here: "The syntax for X is the same as [the syntax] for Y."

@rustagir rustagir merged commit b705149 into mongodb:standardized Nov 15, 2024
4 of 5 checks passed
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