[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/mongo/_mongocommandcursor/dead.xml_mongocursor/d
From:       Jeremy_Mikola <jmikola () php ! net>
Date:       2014-12-28 21:55:05
Message-ID: svn-jmikola-1419803705-335441-1757414129 () svn ! php ! net
[Download RAW message or body]

jmikola                                  Sun, 28 Dec 2014 21:55:05 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=335441

Log:
Revise docs for MongoCursor::dead()

Changed paths:
    U   phpdoc/en/trunk/reference/mongo/mongocommandcursor/dead.xml
    U   phpdoc/en/trunk/reference/mongo/mongocursor/dead.xml

Modified: phpdoc/en/trunk/reference/mongo/mongocommandcursor/dead.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocommandcursor/dead.xml	2014-12-28 21:54:15 \
                UTC (rev 335440)
+++ phpdoc/en/trunk/reference/mongo/mongocommandcursor/dead.xml	2014-12-28 21:55:05 \
UTC (rev 335441) @@ -4,7 +4,7 @@
 <refentry xml:id="mongocommandcursor.dead" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">  <refnamediv>
   <refname>MongoCommandCursor::dead</refname>
-  <refpurpose>Checks if there are documents that have not been sent yet from the \
database for this cursor</refpurpose> +  <refpurpose>Checks if there are results that \
have not yet been sent from the database</refpurpose>  </refnamediv>

  <refsect1 role="description">
@@ -15,19 +15,22 @@
   </methodsynopsis>
   <para>
    This method checks whether the <classname>MongoCommandCursor</classname>
-   cursor has been exhausted and hence can not return more results.
+   cursor has been exhausted and the database has no more results to send to the
+   client. A cursor being "dead" does not necessarily mean that there are no
+   more results available for iteration.
   </para>
  </refsect1>

  <refsect1 role="parameters">
-  &reftitle.parameters;
+  &reftitle.parameters;
   &no.function.parameters;
  </refsect1>

  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns if there are more results that have not been sent to the client, yet.
+   Returns &true; if there are more results that have not yet been sent to the
+   client, and &false; otherwise.
   </para>
  </refsect1>
 </refentry>

Modified: phpdoc/en/trunk/reference/mongo/mongocursor/dead.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/dead.xml	2014-12-28 21:54:15 UTC (rev \
                335440)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/dead.xml	2014-12-28 21:55:05 UTC (rev \
335441) @@ -4,7 +4,7 @@
 <refentry xml:id="mongocursor.dead" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">  <refnamediv>
   <refname>MongoCursor::dead</refname>
-  <refpurpose>Checks if there are documents that have not been sent yet from the \
database for this cursor</refpurpose> +  <refpurpose>Checks if there are results that \
have not yet been sent from the database</refpurpose>  </refnamediv>

  <refsect1 role="description">
@@ -35,7 +35,8 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns if there are more results that have not been sent to the client, yet.
+   Returns &true; if there are more results that have not yet been sent to the
+   client, and &false; otherwise.
   </para>
  </refsect1>
 </refentry>



-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]