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:34:32 +0200 |
| commit | d70ed9439d65a5c5dff3f2b7c3a37a0c175f2f88 (patch) | |
| tree | f68d838b9d7f3b506d30a860e36eea538953550c | |
| parent | 8f8d4b3d526a577004860a6a84302c84ca078308 (diff) | |
| download | django-d70ed9439d65a5c5dff3f2b7c3a37a0c175f2f88.tar.gz | |
[3.0.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 cd2b4ef2e8..c60930c1e5 100644 --- a/docs/topics/signing.txt +++ b/docs/topics/signing.txt @@ -167,12 +167,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. |