From 78b7d262becacd8c1ce84001b5e09a51641629ad Mon Sep 17 00:00:00 2001
From: Jeremy Mikola <jmikola@php.net>
Date: Sun, 28 Dec 2014 21:55:05 +0000
Subject: [PATCH] Revise docs for MongoCursor::dead()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335441 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongo/mongocommandcursor/dead.xml | 11 +++++++----
 reference/mongo/mongocursor/dead.xml        |  5 +++--
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/reference/mongo/mongocommandcursor/dead.xml b/reference/mongo/mongocommandcursor/dead.xml
index 6762e29d42..3c16e5f6d8 100644
--- a/reference/mongo/mongocommandcursor/dead.xml
+++ b/reference/mongo/mongocommandcursor/dead.xml
@@ -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>
diff --git a/reference/mongo/mongocursor/dead.xml b/reference/mongo/mongocursor/dead.xml
index 0c33c1d209..a27f875849 100644
--- a/reference/mongo/mongocursor/dead.xml
+++ b/reference/mongo/mongocursor/dead.xml
@@ -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>