Repository navigation
docs: clarify when stale cache files are removed - #549
Open
boonyongyang wants to merge 1 commit into
Open
boonyongyang wants to merge 1 commit into
boonyongyang wants to merge 1 commit into
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
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.
✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)
Documentation update.
The README describes cleanup as continuous. A reader can reasonably expect a file to be deleted as soon as its
stalePeriodelapses.🆕 What is the new behavior (if this is a feature change)?
The README explains that
stalePeriodapplies during a cleanup pass and that cache metadata lookups schedule cleanup.💥 Does this PR introduce a breaking change?
No
🐛 Recommendations for testing
Verified the wording against the cleanup implementation. On Flutter 3.44.6, all 146 package tests passed, including the cache-store cleanup tests. Formatting and static analysis also passed. Example app builds were outside this documentation check.
📝 Links to relevant issues/docs
Related to Baseflow/flutter_cached_network_image#1026.
🤔 Checklist before submitting
The contribution guide exempts documentation-only changes from the version and changelog step.
Prepared with Codex assistance.