diff --git a/docs/conf.py b/docs/conf.py index 6a345b1b..bdb52d54 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,7 +59,7 @@ html_static_path = ["_static"] html_theme = "furo" html_theme_options = { - "announcement": "Flask-Session is switching serializers to msgpack in 1.0.0. Use version 0.7.0 if you need graceful migration for existing sessions.", + "announcement": "Flask-Session is switching serializer to msgspec in 1.0.0. Version 0.7.0 includes graceful migration for existing sessions.", "source_repository": "https://github.com/pallets-eco/flask-session/", "source_branch": "main", "source_directory": "docs/", diff --git a/docs/config_example.rst b/docs/config_example.rst index 4f34101e..9960da07 100644 --- a/docs/config_example.rst +++ b/docs/config_example.rst @@ -1,4 +1,4 @@ -Configuration example +Example --------------------- Here is an example of how to configure a redis backend: diff --git a/docs/usage.rst b/docs/usage.rst index b76e2bc1..bf18a371 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -31,15 +31,14 @@ then create the :class:`Session` object by passing it the application. def get(): return session.get('key', 'not set') -This would automatically setup a redis client connected to `localhost:6379` and use it to store the session data. +See the configuration section for more details. .. note:: - You can not use :class:`~Session` instance directly, what :class:`~Session` does - is just change the :attr:`~flask.Flask.session_interface` attribute on - your Flask applications. You should always use :class:`flask.session` when accessing or modifying the current session. + You can not use :class:`~Session` instance directly, what :class:`~Session` does + is just change the :attr:`~flask.Flask.session_interface` attribute on + your Flask applications. You should always use :class:`flask.session` when accessing or modifying the current session. -See the configuration section for more details. Alternative initialization ---------------------------