Skip to content
New issue

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

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

Already on GitHub? # to your account

DOCSP-45176: Run a command #130

Merged
merged 5 commits into from
Jan 17, 2025

Conversation

mcmorisi
Copy link
Collaborator

@mcmorisi mcmorisi commented Jan 15, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • databases-collections/run-command
  • databases-collection
  • write/delete
  • 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 Jan 15, 2025

    Deploy Preview for docs-ruby ready!

    Name Link
    🔨 Latest commit 9e431b4
    🔍 Latest deploy log https://app.netlify.com/sites/docs-ruby/deploys/678abb25ce7afb000803f208
    😎 Deploy Preview https://deploy-preview-130--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
    Contributor

    @rachel-mack rachel-mack left a comment

    Choose a reason for hiding this comment

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

    Small fix:


    * - ``ok?``
    - Returns ``true`` if the command succeeded, and ``false`` otherwise. If the ``ok?``
    method returns ``false``The driver raises a ``Mongo::Error::OperationFailure`` .
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Suggested change
    method returns ``false``The driver raises a ``Mongo::Error::OperationFailure`` .
    method returns ``false``, the driver raises a ``Mongo::Error::OperationFailure`` .

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    Good catch!

    Comment on lines 87 to 89
    You can set a read preference for the command execution by passing a
    ``ReadPreference`` instance as a parameter to ``command``, as
    shown in the following code:
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    The example given after this paragraph does not use a ReadPreference instance, instead passing a hash of read preference options. Maybe the paragraph could be adjusted something like:

    Suggested change
    You can set a read preference for the command execution by passing a
    ``ReadPreference`` instance as a parameter to ``command``, as
    shown in the following code:
    You can set a read preference for the command execution by passing the
    ``:read`` option to the ``command`` method, as shown in the following code:

    @mcmorisi mcmorisi merged commit 76c5922 into mongodb:standardization Jan 17, 2025
    1 check passed
    # for free to join this conversation on GitHub. Already have an account? # to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants