Skip to content

Revise docs for Find modifiers option #347

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.

Sign up for GitHub

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 1 commit into from
Mar 16, 2017
Merged

Revise docs for Find modifiers option #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/includes/apiargs-MongoDBCollection-method-find-option.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ arg_name: option
name: modifiers
type: array|object
description: |
Meta-operators that modify the output or behavior of a query. :manual:`Cursor
Methods </reference/method/js-cursor`> describes the query modification
methods available in MongoDB.
:manual:`Meta operators </reference/operator/query-modifier>` that modify the
output or behavior of a query. Use of these operators is deprecated in favor
of named options.
interface: phpmethod
operation: ~
optional: true
Expand Down
5 changes: 3 additions & 2 deletions src/Operation/Find.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,9 @@ class Find implements Executable
* run. If "$maxTimeMS" also exists in the modifiers document, this
* option will take precedence.
*
* * modifiers (document): Meta-operators modifying the output or behavior
* of a query.
* * modifiers (document): Meta operators that modify the output or
* behavior of a query. Use of these operators is deprecated in favor of
* named options.
*
* * noCursorTimeout (boolean): The server normally times out idle cursors
* after an inactivity period (10 minutes) to prevent excess memory use.
Expand Down