summaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-02-15 14:04:39 -0600
committerJordan Cook <jordan.cook@pioneer.com>2022-02-15 14:09:04 -0600
commitb5bac5aae0213b44fe02e362ece9d4ef60ff8793 (patch)
tree88284b25c4d769080ce63bb58e456e46d57745ff /docs/user_guide
parent43c9287b26cefde75b4e22d974b616f9675e4960 (diff)
downloadrequests-cache-b5bac5aae0213b44fe02e362ece9d4ef60ff8793.tar.gz
Fix serialization in filesystem backend with binary content that is also valid UTF-8
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/serializers.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/user_guide/serializers.md b/docs/user_guide/serializers.md
index 2e3621e..b2bae92 100644
--- a/docs/user_guide/serializers.md
+++ b/docs/user_guide/serializers.md
@@ -113,10 +113,13 @@ For example, a compressed pickle serializer can be built as:
```python
>>> import gzip
>>> from requests_cache import CachedSession, SerializerPipeline, Stage, pickle_serializer
->>> compressed_serializer = SerializerPipeline([
-... pickle_serializer,
-... Stage(dumps=gzip.compress, loads=gzip.decompress),
-... ])
+>>> compressed_serializer = SerializerPipeline(
+... [
+... pickle_serializer,
+... Stage(dumps=gzip.compress, loads=gzip.decompress),
+... ],
+... is_binary=True,
+... )
>>> session = CachedSession(serializer=compressed_serializer)
```
:::