From 576216bede8b8555d70480898bf67eed1f0738a9 Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Tue, 26 Jun 2012 09:32:12 -0700
Subject: Issue #1552400 by mjonesdinero, SumeetSingh: Fix documentation for
 user_is_blocked, which was misleading.

---
 modules/user/user.module | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'modules')

diff --git a/modules/user/user.module b/modules/user/user.module
index 0c2839796..47ac64273 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -823,7 +823,12 @@ function user_access($string, $account = NULL) {
 /**
  * Checks for usernames blocked by user administration.
  *
- * @return boolean TRUE for blocked users, FALSE for active.
+ * @param $name
+ *   A string containing a name of the user.
+ *
+ * @return
+ *   Object with property 'name' (the user name), if the user is blocked;
+ *   FALSE if the user is not blocked.
  */
 function user_is_blocked($name) {
   return db_select('users')
-- 
cgit v1.2.3