summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2020-07-31 07:38:01 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2020-07-31 11:33:17 +0200
commit8703680ebee47bfa9e912a30a0509798500bf42a (patch)
tree6f3fe4e8f08a90bcf7e596ef60d23a96baa59ab0 /docs
parent0b655a4bf81f640d3e664f398e635943d4fb7812 (diff)
Corrected signing.dumps()/loads() signatures in docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/signing.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/topics/signing.txt b/docs/topics/signing.txt
index d910a7af52..43d1b00c4a 100644
--- a/docs/topics/signing.txt
+++ b/docs/topics/signing.txt
@@ -185,12 +185,12 @@ and tuples) if you pass in a tuple, you will get a list from
>>> signing.loads(value)
['a', 'b', 'c']
-.. function:: dumps(obj, key=None, salt='django.core.signing', compress=False)
+.. function:: dumps(obj, key=None, salt='django.core.signing', serializer=JSONSerializer, compress=False)
Returns URL-safe, sha1 signed base64 compressed JSON string. Serialized
object is signed using :class:`~TimestampSigner`.
-.. function:: loads(string, key=None, salt='django.core.signing', max_age=None)
+.. function:: loads(string, key=None, salt='django.core.signing', serializer=JSONSerializer, max_age=None)
Reverse of ``dumps()``, raises ``BadSignature`` if signature fails.
Checks ``max_age`` (in seconds) if given.