Skip to content

docs(changelog): correct the warning claims in the #126 and #256 fragments #369

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
allen0099 merged 1 commit into from
Sep 29, 2026
Merged

docs(changelog): correct the warning claims in the #126 and #256 fragments #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions changelog.d/126.deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
**The `encoding` option of `AsyncRedisCacheBackend` and `RedisConfig`.** 0.4.0
removes it and reads raw bytes; entries were always UTF-8. Passing `encoding`
to `AsyncRedisCacheBackend`, or setting it on a `RedisConfig` given to
`load_from_config()`, now emits a `DeprecationWarning`. Leave it out: UTF-8 is
what you get without it. A value other than UTF-8 keeps its `RuntimeWarning`.
removes it and reads raw bytes; entries were always UTF-8. Passing a UTF-8
`encoding` to `AsyncRedisCacheBackend`, or setting `encoding` on a
`RedisConfig` given to `load_from_config()`, now emits a `DeprecationWarning`.
Any other value passed to `AsyncRedisCacheBackend` gets no
`DeprecationWarning`: it keeps its `RuntimeWarning`, which already announces the
removal. Leave it out: UTF-8 is what you get without it.
6 changes: 3 additions & 3 deletions changelog.d/256.deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ default, so every cookie session is logged out once on upgrade and a plain-HTTP
setup stops receiving the cookie. The middleware now emits a `FutureWarning`
when its config leaves `cookie_name` or `cookie_https_only` at the default. Set
both: `cookie_name="session", cookie_https_only=False` keeps the current cookie,
`cookie_name="__Host-session", cookie_https_only=True` switches now. Header-only
setups never send the cookie and do not warn. See "Migrating to 0.4.0" in the
docs.
`cookie_name="__Host-session", cookie_https_only=True` switches now. The
warning does not depend on how clients send the token: a header-only app on
this middleware warns too. See "Migrating to 0.4.0" in the docs.
Loading