Correct documentation for wfPickRandom()'s return types

Also make LoadBalancer::pickRandom()'s one consistent.

Change-Id: Ib80827ef20b32fecb799f327545b1232272076d2

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index 121d6ca..b49ca65 100644 (file)
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -335,7 +335,7 @@ function wfRandomString( $length = 32 ) {
  *
  * @param $weights array
  *
- * @return int|string
+ * @return bool|int|string
  */
 function wfPickRandom( $weights ){
        if ( !is_array( $weights ) || count( $weights ) == 0 ) {

diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php
index d249c27..311691d 100644 (file)
--- a/includes/db/LoadBalancer.php
+++ b/includes/db/LoadBalancer.php
@@ -121,7 +121,7 @@ class LoadBalancer {
         *
         * @param $weights array
         *
-        * @return int
+        * @return bool|int|string
         */
        function pickRandom( $weights ) {
                return wfPickRandom( $weights );