Enhance documentation in lib.rs with comprehensive architecture ove…#27
Merged
Enhance documentation in lib.rs with comprehensive architecture ove…#27
lib.rs with comprehensive architecture ove…#27Conversation
…rview and usage examples - Expanded module documentation to provide a detailed architecture overview, including a trait hierarchy and data structure descriptions. - Added a Quick Start section with code examples for using the `CacheBuilder` and policy-specific APIs, improving usability for new users. - Included a table of eviction policies with feature flags, complexity, and best use cases to guide users in selecting appropriate policies. - Documented thread safety options and metrics features, ensuring clarity on concurrent usage and performance tracking. - Improved overall structure and navigation of the documentation to align with Rust API Guidelines.
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
1 participant
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.
…rview and usage examples
CacheBuilderand policy-specific APIs, improving usability for new users.Type of Change