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 f55281e..507b254 100644 (file)
--- 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.