Clarify schedule_update docs #4127
Open
Conversation
This file contains hidden or 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
ealmloff
reviewed
May 16, 2025
packages/core/src/global_context.rs
Outdated
| /// | ||
| /// Note: Unlike [`needs_update`], the function returned by this method will work outside of the dioxus runtime. | ||
| /// | ||
| /// Note: The function returned by this method will schedule an update for the current component even if it has already updated between when `schedule_update` was called and when the returned function is called. | ||
| /// If the desired behavior is to invalidate the current rendering of the current component (and on-op if already invalidated) |
There was a problem hiding this comment.
Thanks this is more clear. I think on-op should be no-op
packages/core/src/global_context.rs
Outdated
| @@ -349,6 +353,9 @@ pub fn schedule_update() -> Arc<dyn Fn() + Send + Sync> { | |||
| /// A component's [`ScopeId`] can be obtained from the [`current_scope_id`] method. | |||
| /// | |||
| /// Note: Unlike [`needs_update`], the function returned by this method will work outside of the dioxus runtime. | |||
| /// | |||
| /// Note: The function returned by this method will schedule an update for the component even if it has already updated between when `schedule_update` was called and when the returned function is called. | |||
There was a problem hiding this comment.
I'm not sure this comment is relevant to schedule_update_any since it doesn't capture anything about the component. We could still point to ReactiveContext as a way to update any reactive scope, not just components, or remove this comment
There was a problem hiding this comment.
I misread the API. I think the new test is fixed now.
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.
As noted in #4114, the current documentation of
schedule_updatecan be a bit confusing.This attempts to clarify its behavior and direct readers to the well documented
ReactiveContextinstead when appropriate.