Skip to content

Commit b05d10d

Browse files
committed
docs(changelog): add the Documentation entries for the examples and the docs pass
1 parent d5f52d2 commit b05d10d

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,22 @@ Note that 0.3.3 was never released; 0.3.4 follows 0.3.2.
339339
per-token `InsecureKeyLengthWarning`.
340340
([#116](https://github.com/allen0099/FastAPI-CacheX/issues/116))
341341

342+
### Documentation
343+
344+
- **Runnable examples.** `examples/` holds one complete FastAPI app per
345+
feature: HTTP caching, `CacheManager`, cookie and JWT sessions, OAuth
346+
state, `CacheLock`, a rate limiter on `increment()` and a Redis backend.
347+
`tests/test_examples.py` runs each one's main flow, so they keep working
348+
as the library changes. The guide pages link to the matching example.
349+
([#241](https://github.com/allen0099/FastAPI-CacheX/issues/241))
350+
- **Guides checked against 0.3.8.** The distributed lock and contributing
351+
guides are now available in Traditional Chinese. The JWT claims guide uses
352+
`FastAPICacheXSessionMiddleware`, and its custom serializer no longer reads
353+
private attributes. Corrected statements: `invalidate()` raises backend
354+
errors, only the Redis and Memcached backends prefix their keys, and
355+
`CacheLock` is a lease rather than a guarantee of mutual exclusion.
356+
([#214](https://github.com/allen0099/FastAPI-CacheX/issues/214))
357+
342358
## [0.3.7] - 2026-09-25
343359

344360
### Added

0 commit comments

Comments
 (0)