From: Timo Tijhof <krinklemail@gmail.com>
Date: Fri, 11 Sep 2015 04:37:30 +0000 (+0100)
Subject: resourceloader: Document internal mw.loader#jobs property
X-Git-Tag: 1.31.0-rc.0~10047
X-Git-Url: https://git.cyclocoop.org/%7B%24admin_url%7Dcompta/operations/modifier.php?a=commitdiff_plain;h=d5a7559f9928c2048a0917ee0add5a817a98da60;p=lhc%2Fweb%2Fwiklou.git

resourceloader: Document internal mw.loader#jobs property

Also use push() instead of old-fashioned micro-optimising .length
assignment. This is inconsistent with the rest of the code and in
modern browsers push is as fast (or faster; < 0.1% difference).

Change-Id: Iaad007cb7a5f2afcab3f0859d2525d49e86775c0
---

diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/mediawiki/mediawiki.js
index 5ba97814d4..c6e41c45b3 100644
--- a/resources/src/mediawiki/mediawiki.js
+++ b/resources/src/mediawiki/mediawiki.js
@@ -781,7 +781,25 @@
 				// List of modules to be loaded
 				queue = [],
 
-				// List of callback functions waiting for modules to be ready to be called
+				/**
+				 * List of callback jobs waiting for modules to be ready.
+				 *
+				 * Jobs are created by #request() and run by #handlePending().
+				 *
+				 * Typically when a job is created for a module, the job's dependencies contain
+				 * both the module being requested and all its recursive dependencies.
+				 *
+				 * Format:
+				 *
+				 *     {
+				 *         'dependencies': [ module names ],
+				 *         'ready': Function callback
+				 *         'error': Function callback
+				 *     }
+				 *
+				 * @property {Object[]} jobs
+				 * @private
+				 */
 				jobs = [],
 
 				// Selector cache for the marker element. Use getMarker() to get/use the marker!
@@ -1371,14 +1389,14 @@
 
 				// Add ready and error callbacks if they were given
 				if ( ready !== undefined || error !== undefined ) {
-					jobs[ jobs.length ] = {
+					jobs.push( {
 						dependencies: $.grep( dependencies, function ( module ) {
 							var state = mw.loader.getState( module );
 							return state === 'registered' || state === 'loaded' || state === 'loading';
 						} ),
 						ready: ready,
 						error: error
-					};
+					} );
 				}
 
 				$.each( dependencies, function ( idx, module ) {