diff options
| author | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2020-07-31 07:38:01 +0200 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2020-07-31 11:33:50 +0200 |
| commit | 0e02560535115a30b7819afe68928748c55bcb76 (patch) | |
| tree | f35f72919b771184a15bf6accd6df736a041b85d | |
| parent | 32cb1fe1c66645671681407d47e8370b4afbfc3f (diff) | |
[3.1.x] Corrected signing.dumps()/loads() signatures in docs.
Backport of 8703680ebee47bfa9e912a30a0509798500bf42a from master
| -rw-r--r-- | docs/topics/signing.txt | 4 |
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. |