[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/_mongoclient/selectcollection.xml_mongocli
From:       Jeremy_Mikola <jmikola () php ! net>
Date:       2013-01-28 19:47:52
Message-ID: svn-jmikola-1359402472-329315-427098285 () svn ! php ! net
[Download RAW message or body]

jmikola                                  Mon, 28 Jan 2013 19:47:52 +0000

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

Log:
Make Mongo db/collection select method docs consistent

A vanilla Exception is thrown instead of InvalidArgumentException.

Changed paths:
    U   phpdoc/en/trunk/reference/mongo/mongoclient/selectcollection.xml
    U   phpdoc/en/trunk/reference/mongo/mongoclient/selectdb.xml
    U   phpdoc/en/trunk/reference/mongo/mongodb/selectcollection.xml

Modified: phpdoc/en/trunk/reference/mongo/mongoclient/selectcollection.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongoclient/selectcollection.xml	2013-01-28 19:40:25 UTC (rev 329314)
+++ phpdoc/en/trunk/reference/mongo/mongoclient/selectcollection.xml	2013-01-28 19:47:52 UTC (rev 329315)
@@ -54,7 +54,7 @@
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   Throws <classname>InvalidArgumentException</classname> if the database or collection name is invalid.
+   Throws <classname>Exception</classname> if the database or collection name is invalid.
   </para>
  </refsect1>


Modified: phpdoc/en/trunk/reference/mongo/mongoclient/selectdb.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongoclient/selectdb.xml	2013-01-28 19:40:25 UTC (rev 329314)
+++ phpdoc/en/trunk/reference/mongo/mongoclient/selectdb.xml	2013-01-28 19:47:52 UTC (rev 329315)
@@ -36,14 +36,14 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns a new db object.
+   Returns a new database object.
   </para>
  </refsect1>

  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   Throws <classname>InvalidArgumentException</classname> if the database name is invalid.
+   Throws <classname>Exception</classname> if the database name is invalid.
   </para>
  </refsect1>


Modified: phpdoc/en/trunk/reference/mongo/mongodb/selectcollection.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongodb/selectcollection.xml	2013-01-28 19:40:25 UTC (rev 329314)
+++ phpdoc/en/trunk/reference/mongo/mongodb/selectcollection.xml	2013-01-28 19:47:52 UTC (rev 329315)
@@ -13,6 +13,7 @@
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
  </refsect1>
+
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
@@ -23,19 +24,28 @@
      </term>
      <listitem>
       <para>
-       The name of the collection.
+       The collection name.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the collection.
+   Returns a new collection object.
   </para>
  </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws <classname>Exception</classname> if the collection name is invalid.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:



-- 
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]