mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-17 08:09:13 +00:00
Code Issues 32 Releases Wiki Activity

[3.0.x] Corrected signing.dumps()/loads() signatures in docs.

Browse Source 
Backport of 8703680ebee47bfa9e912a30a0509798500bf42a from master
This commit is contained in:
Mariusz Felisiak 2020-07-31 07:38:01 +02:00
parent 8f8d4b3d52
commit d70ed9439d
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/topics/signing.txt
View File

@ -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.