DOCSP-45363: validation

[rustagir]

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-45363
Staging - https://deploy-preview-73--docs-mongoid.netlify.app/data-modeling/validation/

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?

[netlify]

✅ Deploy Preview for docs-mongoid ready!

Name	Link
🔨 Latest commit	7ae1b71
🔍 Latest deploy log	https://app.netlify.com/sites/docs-mongoid/deploys/674dc4945c76090008aacd26
😎 Deploy Preview	https://deploy-preview-73--docs-mongoid.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[stephmarie17]

Nice work! Mostly just nits but a few questions 💬

[stephmarie17]

[q] Not super familiar with Mongoid but is this a common way to explain setting options? Specify to (instead of with)? It reads a little awkwardly, would something like this be accurate:

Suggested change

	whether a field value matches a regular expression. Specify the regular
	expression to the ``with`` option.
	whether a field value matches a regular expression. Use the ``with`` option to specify the regular expression.

[rustagir]

updated

[stephmarie17]

[q] Another Mongoid question 😄 In the linked Active Record docs, they format the options like :greater-than. Should these docs use this format also or not necessary?

[rustagir]

I don't think it's necessary, as we provide an example that shows the symbol syntax!

[stephmarie17]

[s] Not sure if the not in is necessary here, makes it a little hard to parse:

Suggested change

	document based on whether a field value is in or not in a specified list
	of values. Specify the list to the ``in`` option.
	document based on whether a field value is in a specified list
	of values. Specify the list to the ``in`` option.

[stephmarie17]

Suggested change

	condition to add when {+odm+} checks for uniqueness:
	conditions to add when {+odm+} checks for uniqueness:

[stephmarie17]

[s] Suggestion for brevity and to use simple present tense per the style guide:

Suggested change

	queries a secondary member of the replica set, there is a possibility
	that it is reading stale data.
	queries a secondary member of the replica set, it might read stale data.

[stephmarie17]

[s] Suggestion to avoid using as per the style guide:

Suggested change

	Don't use the ``validates_associated`` helper on both ends of your
	associations, as this causes {+odm+} to perform validations in an
	infinite loop.
	Don't use the ``validates_associated`` helper on both ends of your
	associations, because this causes {+odm+} to perform validations in an
	infinite loop.

or

Suggested change

	Don't use the ``validates_associated`` helper on both ends of your
	associations, as this causes {+odm+} to perform validations in an
	infinite loop.
	Don't use the ``validates_associated`` helper on both ends of your
	associations. This causes {+odm+} to perform validations in an
	infinite loop.

[stephmarie17]

Suggested change

	You can run validations manually by using the ``valid?()`` method.This
	You can run validations manually by using the ``valid?()`` method. This

[stephmarie17]

[s] For readability, I think "from" is more commonly used and easier to parse:

Suggested change

	{+odm+} behaves differently to Active Record when running ``valid?()``
	{+odm+} behaves differently from Active Record when running ``valid?()``

[stephmarie17]

[q] I wasn't sure if this sentence is saying that the way Mongoid runs validations is the optimization, or the documents are in memory as optimization? Maybe add a comma for clarity, or omit:

Suggested change

	documents that are in memory as an optimization.
	documents that are in memory, as an optimization.

Suggested change

	documents that are in memory as an optimization.
	documents that are in memory.

[rustagir]

improved wording

[rustagir]

Decided to make this change after considering what was in that page

[stephmarie17]

LGTM!