From d1b673ff59257d7ec68e34a055a5e00644101b50 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Sun, 18 Mar 2018 20:32:05 -0700 Subject: [PATCH] mediawiki.util: Document isIPAddress() allowBlock as optional This was already the case in the code, but the documentation was not reflecting this accurately. Passing 'false' as second parameter is not desirable in most cases. Change-Id: Idbbd7de795b444e401a16292dfb8c9a80f4d07be --- resources/src/mediawiki/mediawiki.util.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/resources/src/mediawiki/mediawiki.util.js b/resources/src/mediawiki/mediawiki.util.js index fb34a89063..d7b3f35367 100644 --- a/resources/src/mediawiki/mediawiki.util.js +++ b/resources/src/mediawiki/mediawiki.util.js @@ -459,7 +459,7 @@ * Note: borrows from IP::isIPv4 * * @param {string} address - * @param {boolean} allowBlock + * @param {boolean} [allowBlock=false] * @return {boolean} */ isIPv4Address: function ( address, allowBlock ) { @@ -480,7 +480,7 @@ * Note: borrows from IP::isIPv6 * * @param {string} address - * @param {boolean} allowBlock + * @param {boolean} [allowBlock=false] * @return {boolean} */ isIPv6Address: function ( address, allowBlock ) { @@ -531,7 +531,7 @@ * * @since 1.25 * @param {string} address String to check - * @param {boolean} allowBlock True if a block of IPs should be allowed + * @param {boolean} [allowBlock=false] If a block of IPs should be allowed * @return {boolean} */ isIPAddress: function ( address, allowBlock ) { -- 2.20.1