mediawiki.api: Fix documentation of ajax() to mention exposed jqXHR
authorGergő Tisza <tgr.huwiki@gmail.com>
Tue, 18 Feb 2014 18:55:04 +0000 (18:55 +0000)
committerTimo Tijhof <krinklemail@gmail.com>
Tue, 25 Feb 2014 08:55:54 +0000 (09:55 +0100)
Fixes the documentation which got out of sync after I49977b5f9
changed the resolution of the promise to also pass the jqXHR.

Change-Id: Ifa9899c1e235af19c3df21337db97cb12b0b5806

resources/mediawiki.api/mediawiki.api.js

index 6012d93..3032f78 100644 (file)
                 *
                 * @param {Object} parameters
                 * @param {Object} [ajaxOptions]
-                * @return {jQuery.Promise} Done: API response data. Fail: Error code
+                * @return {jQuery.Promise} Done: API response data and the jqXHR object.
+                *  Fail: Error code
                 */
                ajax: function ( parameters, ajaxOptions ) {
                        var token,