Skip to content

docs: clarify when stale cache files are removed - #549

Open
boonyongyang wants to merge 1 commit into
Baseflow:mainfrom
boonyongyang:docs/clarify-cache-stale-period
Open

boonyongyang wants to merge 1 commit into
Baseflow:mainfrom
boonyongyang:docs/clarify-cache-stale-period

Conversation

@boonyongyang

Copy link
Copy Markdown

✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)

Documentation update.

⤵️ What is the current behavior?

The README describes cleanup as continuous. A reader can reasonably expect a file to be deleted as soon as its stalePeriod elapses.

🆕 What is the new behavior (if this is a feature change)?

The README explains that stalePeriod applies 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

  • All projects build
  • Follows style guide lines (code style guide)
  • Relevant documentation was updated
  • Rebased onto current main
  • Version bumped and dated CHANGELOG entry added

The contribution guide exempts documentation-only changes from the version and changelog step.

Prepared with Codex assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant