Skip to content

Commit

Permalink
Further documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Lxstr committed Feb 24, 2024
1 parent c0602e2 commit 304d0ab
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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/",
Expand Down
2 changes: 1 addition & 1 deletion docs/config_example.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Configuration example
Example
---------------------

Here is an example of how to configure a redis backend:
Expand Down
9 changes: 4 additions & 5 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------
Expand Down

0 comments on commit 304d0ab

Please sign in to comment.