-
Notifications
You must be signed in to change notification settings - Fork 2k
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.
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
Clarify docs on target-framerate. Fixes #4897 #4941
Conversation
@davidmaxwaterman could you review this PR as well? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Made a few optional suggestions.
lib/elements/dom-repeat.html
Outdated
* 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 |
There was a problem hiding this comment.
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 rAF
s 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.
lib/elements/dom-repeat.html
Outdated
* 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will allow => allows
lib/elements/dom-repeat.html
Outdated
* 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will result => results
Reference Issue
Fixes #4897