svn: /phpdoc/en/trunk/reference/mongo/mongocollection/ aggregate.xml aggregatecursor.xml
| From: | Jeremy Mikola | Date: | Tue, 22 Jul 2014 19:19:50 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mongo/mongocollection/ aggregate.xml aggregatecursor.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-12635@lists.php.net to get a copy of this message | ||
jmikola Tue, 22 Jul 2014 19:19:50 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=334360
Log:
Clarify cursor/explain options for MongoCollection aggregate methods
https://jira.mongodb.org/browse/PHP-1054
Changed paths:
U phpdoc/en/trunk/reference/mongo/mongocollection/aggregate.xml
U phpdoc/en/trunk/reference/mongo/mongocollection/aggregatecursor.xml
Modified: phpdoc/en/trunk/reference/mongo/mongocollection/aggregate.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/aggregate.xml 2014-07-22 17:23:14 UTC (rev
334359)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/aggregate.xml 2014-07-22 19:19:50 UTC (rev
334360)
@@ -57,8 +57,10 @@
<listitem>
<para><literal>"cursor"</literal></para>
<para>
- Options controlling the creation of the cursor object. If you need to
- use this option, you should consider using
+ Options controlling the creation of the cursor object. This option
+ causes the command to return a result document suitable for constructing
+ a <classname>MongoCommandCursor</classname>. If you need to use this
+ option, you should consider using
<methodname>MongoCollection::aggregateCursor</methodname>.
</para>
</listitem>
Modified: phpdoc/en/trunk/reference/mongo/mongocollection/aggregatecursor.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/aggregatecursor.xml 2014-07-22 17:23:14 UTC (rev
334359)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/aggregatecursor.xml 2014-07-22 19:19:50 UTC (rev
334360)
@@ -74,8 +74,10 @@
<listitem>
<para><literal>"explain"</literal></para>
<para>
- Return information on the processing of the pipeline. If you need to
- use this option, you should consider using
+ Return information on the processing of the pipeline. This option may
+ cause the command to return a result document that is unsuitable for
+ constructing a <classname>MongoCommandCursor</classname>. If you need
+ to use this option, you should consider using
<methodname>MongoCollection::aggregate</methodname>.
</para>
</listitem>