mediawiki.cookie: Remove false documentation for options.expiry as number

Follows-up 7c585b5. There was never an implementation for
supporting an offset from now in seconds. The code and tests
account for no such thing.

When passed a number, it will actually end up being passed to
$.cookie, which interprets it as an offset in days (!).

Change-Id: I5d8ed8cb432ca550c62cf415077ffffd91fe2bbd

diff --git a/resources/src/mediawiki/mediawiki.cookie.js b/resources/src/mediawiki/mediawiki.cookie.js
index 6f9f0ab..1b86b61 100644 (file)
--- a/resources/src/mediawiki/mediawiki.cookie.js
+++ b/resources/src/mediawiki/mediawiki.cookie.js
@@ -30,8 +30,7 @@
                 * @param {Date|null} [options.expires=wgCookieExpiration] The expiry date of the cookie.
                 *
                 *   Default cookie expiration is based on `wgCookieExpiration`.  If `wgCookieExpiration` is
-                *   0, a session cookie is set (expires when the browser is closed). For non-zero values of
-                *   `wgCookieExpiration`, the cookie expires `wgCookieExpiration` seconds from now.
+                *   0, a session cookie is set (expires when the browser is closed).
                 *
                 *   If options.expires is null, then a session cookie is set.
                 * @param {string} [options.prefix=wgCookiePrefix] The prefix of the key

diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.cookie.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.cookie.test.js
index c9653da..c6aa3b7 100644 (file)
--- a/tests/qunit/suites/resources/mediawiki/mediawiki.cookie.test.js
+++ b/tests/qunit/suites/resources/mediawiki/mediawiki.cookie.test.js
@@ -169,4 +169,4 @@
                assert.strictEqual( key, 'barfoo' );
        } );
 
-} ( mediaWiki, jQuery ) );
+}( mediaWiki, jQuery ) );