summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGábor Hojtsy2012-04-16 12:38:57 (GMT)
committer Gábor Hojtsy2012-04-16 12:38:57 (GMT)
commitd8592b22931b966d0fa2c61686dc8e3ff2b2a90d (patch)
tree528069f00cab8efb0ee0f18ca87d48f97e94f752
parentb36bfecf1ac413be3862cc4a2817bab1adbcc6ee (diff)
Issue #1441852 by chris.leversuch, cafuego: Better return value documentation for db_query().
-rw-r--r--includes/database.mysql-common.inc5
1 files changed, 3 insertions, 2 deletions
diff --git a/includes/database.mysql-common.inc b/includes/database.mysql-common.inc
index e3e0d85..ead7f36 100644
--- a/includes/database.mysql-common.inc
+++ b/includes/database.mysql-common.inc
@@ -26,8 +26,9 @@
* and TRUE values to decimal 1.
*
* @return
- * A database query result resource, or FALSE if the query was not
- * executed correctly.
+ * Successful SELECT, SHOW, DESCRIBE, EXPLAIN, or other queries which return a
+ * set of results will return a database query result resource. Other
+ * successful queries will return TRUE and failing queries will return FALSE.
*/
function db_query($query) {
$args = func_get_args();