Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Remove leftover mentions of background threads #479

Merged
merged 4 commits into from
Jan 2, 2025

Conversation

tatsuya6502
Copy link
Member

Fixes #464.

  • Remove leftover mentions of background threads from invalidate_all and invalidate_entries_if methods of all cache implementations.
  • Add the following chapters to the crate top level doc page:
    • Cache Policies
    • Implementation Details, with explanations about the channels and maintenance tasks.

Also add the implementation details chapter to the crate level documentation.
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.13%. Comparing base (9d78c2c) to head (cd2b3b3).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #479      +/-   ##
==========================================
- Coverage   94.24%   94.13%   -0.11%     
==========================================
  Files          44       44              
  Lines       20559    20559              
==========================================
- Hits        19376    19354      -22     
- Misses       1183     1205      +22     

@tatsuya6502 tatsuya6502 self-assigned this Jan 2, 2025
@tatsuya6502 tatsuya6502 added the documentation Improvements or additions to documentation label Jan 2, 2025
@tatsuya6502 tatsuya6502 added this to the v0.12.9 milestone Jan 2, 2025
Copy link
Member Author

@tatsuya6502 tatsuya6502 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging.

@tatsuya6502 tatsuya6502 merged commit e7fd7f6 into main Jan 2, 2025
41 checks passed
@tatsuya6502 tatsuya6502 deleted the fix-doc-about-pending-tasks branch January 2, 2025 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Leftover mentions of background threads
1 participant