Skip to content

Conversation

jordan-smith721
Copy link
Contributor

@jordan-smith721 jordan-smith721 commented Nov 19, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-45436
Staging - https://deploy-preview-68--docs-mongoid.netlify.app/data-modeling/field-behaviors/

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 19, 2024

Deploy Preview for docs-mongoid ready!

Name Link
🔨 Latest commit bad91b4
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongoid/deploys/67460ede0dd55b00080d72b2
😎 Deploy Preview https://deploy-preview-68--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.

@jordan-smith721 jordan-smith721 marked this pull request as ready for review November 19, 2024 17:26
Copy link

@stephmarie17 stephmarie17 left a comment

Choose a reason for hiding this comment

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

LGTM with a few edits in the comments ⚡

Comment on lines 31 to 32
The following example specifies a fixed default value for the ``fulfill_by``
field:

Choose a reason for hiding this comment

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

In this code example, the field is state should this be updated or the should the code snippet be updated:

Suggested change
The following example specifies a fixed default value for the ``fulfill_by``
field:
The following example specifies a fixed default value for the ``state``
field:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, it should be state

Comment on lines 90 to 91
referring to the field by its original name in your application. This can be
useful to save storage space, because MongoDB stores all field information along

Choose a reason for hiding this comment

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

[s] Can potentially edit this for brevity and avoiding extra words:

Suggested change
referring to the field by its original name in your application. This can be
useful to save storage space, because MongoDB stores all field information along
referring to the field by its original name in your application. This can save storage space, because MongoDB stores all field information along


By default, {+odm+} defines the ``_id`` field on documents to contain a
``BSON::ObjectId`` value that {+odm+} generates automatically. You can customize
the type or the specify the default value of the ``_id`` field by specifying it in your

Choose a reason for hiding this comment

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

Suggested change
the type or the specify the default value of the ``_id`` field by specifying it in your
the type or specify the default value of the ``_id`` field by specifying it in your

Comment on lines 165 to 166
You can omit the default value for the ``_id`` field. If you don't specify a
default value for the field, {+odm+} persists the value without an ``_id``

Choose a reason for hiding this comment

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

Is this meant to be document? Was a little hard to parse.

Suggested change
You can omit the default value for the ``_id`` field. If you don't specify a
default value for the field, {+odm+} persists the value without an ``_id``
You can omit the default value for the ``_id`` field. If you don't specify a
default value for the field, {+odm+} persists the document without an ``_id``

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops, yeah that should be document

Comment on lines 167 to 170
value. If the document is a top-level document, the MongoDB server automatically
assigns an ``_id`` value to the document. However, if the document is an
embedded document, the server does not assign an ``_id`` value.

Choose a reason for hiding this comment

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

[s] Suggestions for editing this a bit to improve readability:

Suggested change
value. If the document is a top-level document, the MongoDB server automatically
assigns an ``_id`` value to the document. However, if the document is an
embedded document, the server does not assign an ``_id`` value.
value. For top-level documents, the MongoDB server automatically
assigns an ``_id`` value. However, for embedded documents, the server does not assign an ``_id`` value.

@jordan-smith721 jordan-smith721 merged commit a436575 into mongodb:standardized Nov 26, 2024
1 check passed
@jordan-smith721 jordan-smith721 deleted the field-behaviors branch November 26, 2024 18:09
rustagir added a commit that referenced this pull request Jan 28, 2025
* DOCSP-42732: qs

* fix

* wip

* remove action

* NR suggestion

* DOCSP-42732: qs download

* wip

* adapt for sinatra

* vale fix

* snooty landing page

* MW PR fixes 1

* DOCSP-42733: atlas prep qs

* MW PR fixes 1

* DOCSP-42735: configure cxn

* small fix - vale

* JS PR fixes 1

* DOCSP-44008: read/write sinatra quickstart

* fixes

* NR PR fixes 1

* DOCSP-43961: rails qs

* vale

* ordering

* small fix

* MW PR fixes 1

* small fixes

* MW PR fixes 2

* DOCSP-44647: add to existing app

* fix vale action

* vale fixes

* depth

* MW PR fixes 1

* fixes

* DOCSP-42745: interact with data drawer

* tags

* fix vale action

* remove extra word

Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>

* DOCSP-42753: specify query part 1

* vale

* title

* code edits

* MW PR fixes 2

* DOCSP-44849: modify results

* vale

* JS PR fixes 1

* fix

* fix

* list fixes

* MW PR fixes 1

* DOCSP-44954: scoping

* add landing page

* link

* vale

* highlighting

* DOCSP-44821: specify a query pt 2

* MR PR fixes 1

* wip

* wip

* wip

* small fixes

* DOCSP-42767 Aggregation (#57)

* DOCSP-42774: transactions

* vale

* link text

* MW PR fixes 1

* MR PR fixes 1

* DOCSP-45306: model data drawer

* DOCSP-45330: inheritance (WIP)

* MR PR fixes 2

* try using roles

* wip

* vale

* add label

* fixes

* fix

* small fixes - MW

* DOCSP-45358: documents

* fix

* wip

* wip

* DR tech review 1

* page fmt

* page fmt

* SA PR fixes 1

* MR PR fixes 1

* DR small fix

Co-authored-by: Dmitry Rybakov <160598371+comandeo-mongo@users.noreply.github.com>

* DOCSP-45360: nested attributes (#71)

* DOCSP-45360: nested attributes

* vale + fixes

* fixes

* NR PR fixes 1

* DOCSP-45362: text search (#72)

* DOCSP-45362: text search

* wip

* vale

* MM PR fixes 1

* DOCSP-45436 Field Behaviors page (#68)

* DOCSP-45363: validation (#73)

* DOCSP-45363: validation

* keywords

* wip

* SA PR fixes 1

* DOCSP-44794 Field Types (#69)

* DOCSP-45357 Sharding Configuration (#76)

* DOCSP-42762: Indexes (#74)

* DOCSP-45367 Associations pt. 1 (#79)

* DOCSP-45368: Persistence Configuration (#77)

* DOCSP-45361: callbacks (#75)

* DOCSP-45361: callbacks

* wip

* wip

* wip

* NR PR fixes 1

* DOCSP-45364: CRUD pt 1 (#81)

* checkpoint

* checkpoint 2

* woohoo first pass

* indent

* Edits

* updates

* vale chekcs

* RR PR fixes 1

* fix code file

* code fixes

* RM PR fixes 1

---------

Co-authored-by: rustagir <rea.rustagi@mongodb.com>

* DOCSP-45110: queries subsections (#80)

* DOCSP-45110: queries misc sections

* wip:

* vale

* MR PR fixes 1

* GM PR fixes 1

* DOCSP-46072 Associations part 2 (#82)

* DOCSP-46394: CRUD remaining sections (#83)

* DOCSP-46394: CRUD remaining sections

* vale fixes

* JS PR fixes 1

* DOCSP-46213: bump to rails 8 and remove old tuts (#84)

* DOCSP-45356: i&h + code doc (#86)

* DOCSP-45356: i&h + code doc

* remove contributing

* vale fixes

* link fix

* vale fixes + RM comment

* DOCSP-42770: release notes/whats new (#87)

* DOCSP-42770: release notes/whats new

* fixes

* fixes

* DOCSP-42773: api links (#88)

* DOCSP-42773: api links

* fix

* link fixes

* DOCSP-42772: compatibility (#90)

* DOCSP-42772: compatibility

* small fix

* small fix

* SA PR fixes 1

* delete files for old build system

* column width adjustment

* DOCSP-45366 Encryption (#89)

* DOCSP-42741: config pages (#91)

* DOCSP-42741: config

* wip

* wip

* some vale fixes

* RM PR fixes 1

* small fix

* DOCSP-46555: rails integration (#92)

* wip

* DOCSP-46555: rails integration

* RM PR fixes 1

* DOCSP-45359 External Resources (#94)

* add additional resources page

* edits

* feedback

* DOCSP-42743 Collection config (#95)

* DOCSP-42730: landing page (#96)

* DOCSP-42730: landing page

* MW PR fixes 1

* small fix

* small fix

* small fix

* DOCSP-46121: cleanup (#97)

* cleanup

* copy compat action

* redirects

* MW PR fixes 1

* add index section

* change vs in redirects

---------

Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>
Co-authored-by: Dmitry Rybakov <160598371+comandeo-mongo@users.noreply.github.com>
Co-authored-by: Maya Raman <maya.raman19@gmail.com>
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