From: Timo Tijhof <krinklemail@gmail.com>
Date: Mon, 19 Mar 2018 03:32:05 +0000 (-0700)
Subject: mediawiki.util: Document isIPAddress() allowBlock as optional
X-Git-Tag: 1.31.0-rc.0~349^2
X-Git-Url: http://git.cyclocoop.org/?a=commitdiff_plain;h=d1b673ff59257d7ec68e34a055a5e00644101b50;p=lhc%2Fweb%2Fwiklou.git

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
---

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 ) {