Fix incorrect comment for RememberedEffect in README #1
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
skydoves
approved these changes
Mar 11, 2025
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.
First of all, thank you for creating this library!
While reading through the README, I noticed a small inconsistency in the RememberedEffect section. The main description correctly explains that unlike LaunchedEffect, RememberedEffect doesn't create or launch a new coroutine scope on each key change. However, the comment in the code example states the opposite: "It will launch a new coroutine scope regardless the task is related to the coroutines."
I've updated the comment to align with the actual behavior described in the explanation above.
Thank you again for this valuable contribution to the Compose ecosystem!