From: jeroendedauw <jeroendedauw@gmail.com>
Date: Wed, 28 Nov 2012 19:37:05 +0000 (+0100)
Subject: Improve type hint
X-Git-Tag: 1.31.0-rc.0~21477^2
X-Git-Url: http://git.cyclocoop.org/%22%2C%20generer_url_ecrire%28?a=commitdiff_plain;h=a91a5c741a66832ce6b22222c4b249643ec89fec;p=lhc%2Fweb%2Fwiklou.git

Improve type hint

Eclipse and phpstorm where showing 'User' as return type before, which causes me to not check for false somewhere and thus fatals happening :)

Change-Id: Ibd5b5598f05e6b08481ad65060c7cae18762dc4e
---

diff --git a/includes/User.php b/includes/User.php
index f55281e24e..507b254f69 100644
--- a/includes/User.php
+++ b/includes/User.php
@@ -370,7 +370,7 @@ class User {
 	 *    User::getCanonicalName(), except that true is accepted as an alias
 	 *    for 'valid', for BC.
 	 *
-	 * @return User object, or false if the username is invalid
+	 * @return User|bool User object, or false if the username is invalid
 	 *    (e.g. if it contains illegal characters or is an IP address). If the
 	 *    username is not present in the database, the result will be a user object
 	 *    with a name, zero user ID and default settings.