Skip to content

Clarify docs on target-framerate. Fixes #4897 #4941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 21, 2017
Merged

Clarify docs on target-framerate. Fixes #4897 #4941

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c18a534
Clarify docs on target-framerate. Fixes #4897
kevinpschaaf Nov 17, 2017
348ed92
Also clarify `delay` units. Fixes #4707
kevinpschaaf Nov 17, 2017
80a7f1e
Comment reworded based on feedback.
Nov 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions lib/elements/dom-repeat.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is kind of long. Maybe break sentence here: "... a given second. It does this by measuring the time between rAFs and continuously adjusting the number of items created each rAF to maintain the target framerate."

I also tried an optional rewording here to emphasize the fact that the process is ongoing rather than one-time. Totally optional if you prefer the current text.

* 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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will allow => allows

* 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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will result => results

* the remaining items to complete rendering.
*/
targetFramerate: {
type: Number,
Expand Down