-
Notifications
You must be signed in to change notification settings - Fork 536
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
docs: update Presence throttling notes #23377
docs: update Presence throttling notes #23377
Conversation
to match presence package readme. Throttling implementation was added in v2.11.0.
|
||
You can configure the grouping and throttling behavior using the `allowableUpdateLatencyMs` property as in the following example: | ||
|
||
```ts |
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.
Not for this PR, but this reminded me: I'm trying to establish a pattern for maintaining "living" code examples for use in docs contexts like this. I'd be interested in your thoughts on it.
PR: #23324
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.
I like living examples. To be most effective they would have to be tied to the released code. But most docs are slightly divorced from what is released. That means updating after or with release and we'll mess it up. I support figuring it all out for sure.
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.
But most docs are slightly divorced from what is released.
True in a lot of cases, but for package-local documentation like this, the two should generally be in-sync.
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.
Main docs are from main branch and API docs are from latest released branch. That 2-to-3-week possible disparity is what you mean by "generally in-sync"?
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
to match presence package readme.
Throttling implementation was added in v2.11.0.