DOCSP-35943: write operations reorg #3275
Merged
+891
−644
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
norareidy
requested changes
Feb 13, 2025
|
|
||
| Update or Insert in a Single Operation | ||
| -------------------------------------- | ||
| To learn more about any of the methods shown on this page, see the |
There was a problem hiding this comment.
S: to stay consistent with "guide"
Suggested change
| To learn more about any of the methods shown on this page, see the | |
| To learn more about any of the methods included in this guide, see the |
|
|
||
| If the id values do not match any documents, the ``destroy()`` method | ||
| returns returns ``0``. | ||
| To learn more about inserting documents, see the |
There was a problem hiding this comment.
S:
Suggested change
| To learn more about inserting documents, see the | |
| To learn more about deleting documents, see the |
|
|
||
| To learn more about inserting documents, see the |
There was a problem hiding this comment.
S:
Suggested change
| To learn more about inserting documents, see the | |
| To learn more about deleting documents, see the |
| :dedent: | ||
| :start-after: begin model insert one | ||
| :end-before: end model insert one | ||
| :caption: Insert a document by calling the save() method on an instance. |
There was a problem hiding this comment.
S: I don't think you need this caption; since you're already introducing the code example pretty thoroughly it seems repetitive
There was a problem hiding this comment.
Applies to the other code captions too
There was a problem hiding this comment.
deleted all of the captions on the write subpages
| When the ``insert()`` method succeeds, it returns the value ``1``. If it | ||
| fails, it throws an exception. | ||
|
|
||
| The example code saves multiple models in a single call by passing them as |
There was a problem hiding this comment.
S:
Suggested change
| The example code saves multiple models in a single call by passing them as | |
| The following example code saves multiple models in a single call by passing them as |
| in the array. The following code example shows the structure of a ``push()`` | ||
| method call: | ||
|
|
||
| .. code-block:: none |
There was a problem hiding this comment.
S:
Suggested change
| .. code-block:: none | |
| .. code-block:: php |
| from the array. The following code example shows the structure of a | ||
| ``pull()`` method call: | ||
|
|
||
| .. code-block:: none |
There was a problem hiding this comment.
S:
Suggested change
| .. code-block:: none | |
| .. code-block:: php |
There was a problem hiding this comment.
applies to the other syntax code examples too
| - Call the ``$model->delete()`` method on an instance of the model. | ||
| - Chain methods to retrieve and delete an instance of a model by calling the | ||
| ``delete()`` method. | ||
| - Call the ``Model::destroy($id)`` method on the model, passing it the id of |
There was a problem hiding this comment.
S:
Suggested change
| - Call the ``Model::destroy($id)`` method on the model, passing it the id of | |
| - Call the ``Model::destroy($id)`` method on the model, passing it the ``_id`` value of |
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example shows how to delete a document by passing the value of | ||
| its id to the ``Model::destroy($id)`` method: |
There was a problem hiding this comment.
S:
Suggested change
| its id to the ``Model::destroy($id)`` method: | |
| its ``_id`` to the ``Model::destroy($id)`` method: |
There was a problem hiding this comment.
applies to all mentions of "id"
| deleted. | ||
|
|
||
| If the id value does not match any documents, the ``destroy()`` method | ||
| returns returns ``0``. |
There was a problem hiding this comment.
S:
Suggested change
| returns returns ``0``. | |
| returns ``0``. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://jira.mongodb.org/browse/DOCSP-35943
Reorganizes content on Write Operations page into separate files
STAGING
^ edits are mostly in this landing page, nearly all of the content on the drawer pages was directly copy/pasted from the main page pre-edits
Checklist