From 17f2ba7facb64268ef14f6c29e79cf0e240c78d9 Mon Sep 17 00:00:00 2001 From: Simon Knox Date: Tue, 31 Oct 2017 14:25:52 +0200 Subject: [PATCH] update docstring --- app/assets/javascripts/smart_interval.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/assets/javascripts/smart_interval.js b/app/assets/javascripts/smart_interval.js index 89e7a4ebc5c..f7cddc7e874 100644 --- a/app/assets/javascripts/smart_interval.js +++ b/app/assets/javascripts/smart_interval.js @@ -5,7 +5,7 @@ export default class SmartInterval { /** - * @param { function } opts.callback Function to be called on each iteration (required) + * @param { function } opts.callback A Promise, called on each iteration (required) unless still in progress * @param { milliseconds } opts.startingInterval `currentInterval` is set to this initially * @param { milliseconds } opts.maxInterval `currentInterval` will be incremented to this * @param { milliseconds } opts.hiddenInterval `currentInterval` is set to this