Skip to content

Commit ab28440

Browse files
cdunklauasvetlov
authored andcommitted
Fix #214 - docs should refer to JSON not pickle (#220)
Also fix doc building issue due to NameError on alabaster
1 parent ee8b761 commit ab28440

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import os
1818
import codecs
1919
import re
20+
import alabaster
2021

2122
_docs_path = os.path.dirname(__file__)
2223
_version_path = os.path.abspath(os.path.join(_docs_path,

docs/reference.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,13 @@ Session
106106

107107
.. note::
108108

109-
Keys and values of session data must be pickleable. This
109+
Keys and values of session data must be JSON serializable
110+
when using one of the included storage backends. This
110111
means, typically, that they are instances of basic types of
111112
objects, such as strings, lists, dictionaries, tuples,
112113
integers, etc. If you place an object in a session data key
113-
or value that is not pickleable, an error will be raised when
114-
the session is serialized.
114+
or value that is not JSON serializable, an error will be raised
115+
when the session is serialized.
115116

116117
If you place a mutable value (for example, a list or a
117118
dictionary) in a session object, and you subsequently mutate

0 commit comments

Comments
 (0)