From 87e3665b0126b9492174a16352853f079f1c6127 Mon Sep 17 00:00:00 2001 From: Alexander Corn Date: Thu, 4 Feb 2016 21:49:54 -0500 Subject: [PATCH] Revised JSDoc language (#80) --- components/confirmations.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/confirmations.js b/components/confirmations.js index 880a39e..64e923b 100644 --- a/components/confirmations.js +++ b/components/confirmations.js @@ -165,7 +165,7 @@ function request(community, url, key, time, tag, params, json, callback) { /** * Start automatically polling our confirmations for new ones. The `confKeyNeeded` event will be emitted when we need a confirmation key, or `newConfirmation` when we get a new confirmation - * @param {int} pollInterval - The interval, in milliseconds, at which we will poll for confirmations. This shouldn't be any less than 10,000 probably. + * @param {int} pollInterval - The interval, in milliseconds, at which we will poll for confirmations. This should probably be at least 10,000 to avoid rate-limits. * @param {Buffer|string|null} [identitySecret=null] - Your identity_secret. If passed, all confirmations will be automatically accepted and nothing will be emitted. */ SteamCommunity.prototype.startConfirmationChecker = function(pollInterval, identitySecret) {