Skip to content

DOCSP-45188: Replace #108

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
merged 4 commits into from
Dec 20, 2024
Merged

Conversation

mcmorisi
Copy link
Collaborator

@mcmorisi mcmorisi commented Dec 17, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-45188

Staging Links

  • write/replace
  • 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 Dec 17, 2024

    Deploy Preview for docs-ruby ready!

    Name Link
    🔨 Latest commit f5ccbd0
    🔍 Latest deploy log https://app.netlify.com/sites/docs-ruby/deploys/6761cd41b8cb8b0008c3f189
    😎 Deploy Preview https://deploy-preview-108--docs-ruby.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
    Collaborator

    @jordan-smith721 jordan-smith721 left a comment

    Choose a reason for hiding this comment

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

    A few minor things but otherwise LGTM


    You must pass the following parameters to the ``replace_one`` method:

    - **Query filter**: Matches which documents to update. To learn
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: Matches doesn't seem like the right word in this context imo

    Suggested change
    - **Query filter**: Matches which documents to update. To learn
    - **Query filter**: Specifies which documents to update. To learn

    Comment on lines 70 to 71
    Replace One Document
    --------------------
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Having this heading here made me think the page was missing a Replace Many header or something. Since this whole page is just about the replace_one method, I don't think this header is necessary

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Could also move this change this header to be one level down (with ~~~ instead) and call it Replace Example or something similar

    variables for the operation. Values must be constant or closed
    expressions that don't reference document fields.

    The following code performs the same replace operation as above, but sets the ``upsert``
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Style guide - use "preceding" to locate information on a page

    Suggested change
    The following code performs the same replace operation as above, but sets the ``upsert``
    The following code performs the same replace operation as the preceding example, but sets the ``upsert``

    @mcmorisi mcmorisi merged commit f45d775 into mongodb:standardization Dec 20, 2024
    5 checks passed
    @mcmorisi mcmorisi deleted the DOCSP-45188-replace branch December 20, 2024 17:45
    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.

    3 participants