Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

DOCSP-35943: write operations reorg #3275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rustagir merged 5 commits into mongodb:5.1 from rustagir:DOCSP-35943-write-ops-reorg
Feb 13, 2025

Conversation

@rustagir
Copy link
Contributor

@rustagir rustagir commented Feb 12, 2025 •
edited
Loading

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

  • Add tests and ensure they pass

Copy link
Contributor

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

I mostly left small copy edits but I'll take another look!


Update or Insert in a Single Operation
--------------------------------------
To learn more about any of the methods shown on this page, see the
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

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

rustagir reacted with thumbs up emoji

If the id values do not match any documents, the ``destroy()`` method
returns returns ``0``.
To learn more about inserting documents, see the
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S:

Suggested change
To learn more about inserting documents, see the
To learn more about deleting documents, see the

rustagir reacted with thumbs up emoji
To view a runnable example that deletes multiple documents, see the
:ref:`laravel-delete-many-usage` usage example.

To learn more about inserting documents, see the
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S:

Suggested change
To learn more about inserting documents, see the
To learn more about deleting documents, see the

rustagir reacted with thumbs up emoji
: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.
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S: I don't think you need this caption; since you're already introducing the code example pretty thoroughly it seems repetitive

Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

Applies to the other code captions too

rustagir reacted with thumbs up emoji
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

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

rustagir reacted with thumbs up emoji
in the array. The following code example shows the structure of a ``push()``
method call:

.. code-block:: none
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S:

Suggested change
.. code-block:: none
.. code-block:: php

rustagir reacted with thumbs up emoji
from the array. The following code example shows the structure of a
``pull()`` method call:

.. code-block:: none
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S:

Suggested change
.. code-block:: none
.. code-block:: php

rustagir reacted with thumbs up emoji
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

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

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

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

rustagir reacted with thumbs up emoji
~~~~~~~~~~~~~~~~

The following example shows how to delete a document by passing the value of
its id to the ``Model::destroy($id)`` method:
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S:

Suggested change
its id to the ``Model::destroy($id)`` method:
its ``_id`` to the ``Model::destroy($id)`` method:

rustagir reacted with thumbs up emoji
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

applies to all mentions of "id"

deleted.

If the id value does not match any documents, the ``destroy()`` method
returns returns ``0``.
Copy link
Contributor

@norareidy norareidy Feb 13, 2025

Choose a reason for hiding this comment

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

S:

Suggested change
returns returns ``0``.
returns ``0``.

Copy link
Contributor

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

LGTM!

@rustagir rustagir merged commit 152fc55 into mongodb:5.1 Feb 13, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@norareidy norareidy norareidy approved these changes

Assignees

No one assigned

Labels

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /