Mark MESOP_CONCURRENT_UPDATES_ENABLED as deprecated and update WebSockets docs #1223
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richard-to
approved these changes
Mar 5, 2025
docs/api/config.md
Outdated
| @@ -258,7 +258,9 @@ By default, this is not enabled. You can enable this by setting it to `true`. | |||
|
|
|||
| This is an experimental feature and is subject to breaking change. Please follow [https://github.com/google/mesop/issues/1028](https://github.com/google/mesop/issues/1028) for updates. | |||
|
|
|||
| This uses WebSockets instead of HTTP Server-Sent Events (SSE) as the transport protocol for UI updates. If you set this environment variable to `true`, then [`MESOP_CONCURRENT_UPDATES_ENABLED`](#MESOP_CONCURRENT_UPDATES_ENABLED) will automatically be enabled as well. | |||
| This uses WebSockets instead of HTTP Server-Sent Events (SSE) as the transport protocol for UI updates. Enabling this also enables user events to be handled concurrently, which is particularly useful supporting interactivity for long-running event handlers. | |||
There was a problem hiding this comment.
Maybe adjust the wording a bit for Enabling this also enables...
Sounds a bit odd now that we've deprecating MESOP_CONCURRENT_UPDATES_ENABLED. But can update when it's fully removed.
There was a problem hiding this comment.
slightly reworded this and also added some caveats above on what this means.
wwwillchen
force-pushed
the
deprecate-concurrent
branch
from
42d888c to
919e1ef
Compare
wwwillchen
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.