From: Timo Tijhof <krinklemail@gmail.com>
Date: Tue, 20 Feb 2018 04:47:39 +0000 (-0800)
Subject: mw.loader: Document mw.loader.require() as private
X-Git-Tag: 1.31.0-rc.0~566^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/banques/ajouter.php?a=commitdiff_plain;h=28aad9af384e17fc6192cc58ec1f019141248d93;p=lhc%2Fweb%2Fwiklou.git

mw.loader: Document mw.loader.require() as private

Only public for debugging purposes.

Change-Id: Icc44e11ec6874d7f74ed527e87a80dd06b4edb3a
---

diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/mediawiki/mediawiki.js
index e9efc1668f..a2e071e11a 100644
--- a/resources/src/mediawiki/mediawiki.js
+++ b/resources/src/mediawiki/mediawiki.js
@@ -1982,6 +1982,12 @@
 				 *         OO.compare( [ 1 ], [ 1 ] );
 				 *     } );
 				 *
+				 * Example of inline dependency obtained via `require()`:
+				 *
+				 *     mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
+				 *         var util = require( 'mediawiki.util' );
+				 *     } );
+				 *
 				 * Since MediaWiki 1.23 this also returns a promise.
 				 *
 				 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
@@ -2154,9 +2160,14 @@
 				/**
 				 * Get the exported value of a module.
 				 *
-				 * Modules may provide this via their local `module.exports`.
+				 * This static method is publicly exposed for debugging purposes
+				 * only and must not be used in production code. In production code,
+				 * please use the dynamically provided `require()` function instead.
 				 *
-				 * @protected
+				 * In case of lazy-loaded modules via mw.loader#using(), the returned
+				 * Promise provides the function, see #using() for examples.
+				 *
+				 * @private
 				 * @since 1.27
 				 * @param {string} moduleName Module name
 				 * @return {Mixed} Exported value