Skip to content

[Docs] Fix typos in README.md #36

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.

Sign up for GitHub

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

Merged
haochengxia merged 2 commits into from
Aug 5, 2025
Merged

[Docs] Fix typos in README.md #36

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ca6849
Fix links in README.md
haochengxia Aug 5, 2025
e2d841c
Remove redundant bracket in README.md
haochengxia Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The `PluginCache` allows you to define custom caching behavior through Python ca

| Function | Signature | Description |
|----------|-----------|-------------|
| `init_hook` | `((common_cache_params: CommonCacheParams)) -> Any` | Initialize your data structure |
| `init_hook` | `(common_cache_params: CommonCacheParams) -> Any` | Initialize your data structure |
| `hit_hook` | `(data: Any, request: Request) -> None` | Handle cache hits |
| `miss_hook` | `(data: Any, request: Request) -> None` | Handle cache misses |
| `eviction_hook` | `(data: Any, request: Request) -> int` | Return object ID to evict |
Expand Down Expand Up @@ -151,9 +151,9 @@ By defining custom hook functions for cache initialization, hit, miss, eviction,

### Getting Help

- Check [project documentation](docs.libcachesim.com/python) for detailed guides
- Open issues on [GitHub](https://github.com/cacheMon/libCacheSim-python/issues)
- Review [examples](/example) in the main repository
- Check [project documentation](https://docs.libcachesim.com/python) for detailed guides
- Open issues on [GitHub](https://github.com/cacheMon/libCacheSim-python/issues/new/choose)
- Review [examples](/examples) in the main repository
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 5, 2025

Choose a reason for hiding this comment

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

medium

While correcting the path to /examples is a good fix, using a relative link for a directory might not work as expected on all platforms where this README is displayed (like PyPI). It would be more robust to use the full absolute URL to the examples directory on GitHub, similar to the other links in this section.

Suggested change
- Review [examples](/examples) in the main repository
- Review [examples](https://github.com/cacheMon/libCacheSim-python/tree/main/examples) in the main repository


---
## Reference
Expand Down