From c18a5349a347114e4081a525e1e5d91cd981138a Mon Sep 17 00:00:00 2001 From: Kevin Schaaf Date: Fri, 17 Nov 2017 10:08:38 -0800 Subject: [PATCH 1/3] Clarify docs on target-framerate. Fixes #4897 --- lib/elements/dom-repeat.html | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/elements/dom-repeat.html b/lib/elements/dom-repeat.html index 9c0e601927..73a979ff1a 100644 --- a/lib/elements/dom-repeat.html +++ b/lib/elements/dom-repeat.html @@ -250,12 +250,16 @@ }, /** - * When `initialCount` is used, this property defines a frame rate to - * target by throttling the number of instances rendered each frame to - * not exceed the budget for the target frame rate. Setting this to a + * When `initialCount` is used, this property defines a frame rate (in + * fps) to target by throttling the number of instances rendered each + * frame to not exceed the budget for the target frame rate. The + * framerate is effectively the number of `requestAnimationFrame`s that + * it tries to allow to actually fire in a given second, and it targets + * this by empirically measuring the time between rAF's and throttling + * up/down the number of items created each `rAF`. Setting this to a * higher number will allow lower latency and higher throughput for - * things like event handlers, but will result in a longer time for the - * remaining items to complete rendering. + * event handlers and other tasks, but will result in a longer time for + * the remaining items to complete rendering. */ targetFramerate: { type: Number, From 348ed92cdf71647b67be125bcd2d8acf41e7d1cd Mon Sep 17 00:00:00 2001 From: Kevin Schaaf Date: Fri, 17 Nov 2017 11:10:42 -0800 Subject: [PATCH 2/3] Also clarify `delay` units. Fixes #4707 --- lib/elements/dom-repeat.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/elements/dom-repeat.html b/lib/elements/dom-repeat.html index 73a979ff1a..bd6459498d 100644 --- a/lib/elements/dom-repeat.html +++ b/lib/elements/dom-repeat.html @@ -218,7 +218,7 @@ /** * When using a `filter` or `sort` function, the `delay` property - * determines a debounce time after a change to observed item + * determines a debounce time in ms after a change to observed item * properties that must pass before the filter or sort is re-run. * This is useful in rate-limiting shuffling of the view when * item changes may be frequent. From 80a7f1e57d3b7e684308d88d47bd76bb18067c95 Mon Sep 17 00:00:00 2001 From: Steven Orvell Date: Tue, 21 Nov 2017 11:36:24 -0800 Subject: [PATCH 3/3] Comment reworded based on feedback. --- lib/elements/dom-repeat.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/elements/dom-repeat.html b/lib/elements/dom-repeat.html index bd6459498d..78d71d9281 100644 --- a/lib/elements/dom-repeat.html +++ b/lib/elements/dom-repeat.html @@ -254,12 +254,12 @@ * fps) to target by throttling the number of instances rendered each * frame to not exceed the budget for the target frame rate. The * framerate is effectively the number of `requestAnimationFrame`s that - * it tries to allow to actually fire in a given second, and it targets - * this by empirically measuring the time between rAF's and throttling - * up/down the number of items created each `rAF`. Setting this to a - * higher number will allow lower latency and higher throughput for - * event handlers and other tasks, but will result in a longer time for - * the remaining items to complete rendering. + * it tries to allow to actually fire in a given second. It does this + * by measuring the time between `rAF`s and continuously adjusting the + * number of items created each `rAF` to maintain the target framerate. + * Setting this to a higher number allows lower latency and higher + * throughput for event handlers and other tasks, but results in a + * longer time for the remaining items to complete rendering. */ targetFramerate: { type: Number,