summaryrefslogtreecommitdiff
path: root/docs/topics/signing.txt
diff options
context:
space:
mode:
authorAntoine Catton <acatton@fusionbox.com>2013-10-29 12:36:22 -0600
committerTim Graham <timograham@gmail.com>2013-10-30 08:26:33 -0400
commite9a356a695094fa8a6c4c2b3d1629332bd875b93 (patch)
treefa9415b50fe13ba04b81cf79b248544098f76e09 /docs/topics/signing.txt
parent1edef50880f740e00fa1cd501c2ac56ec6fd10e4 (diff)
Documented the limitation on sep argument to Signer
Co-Authored-By: Gavin Wahl <gwahl@fusionbox.com>
Diffstat (limited to 'docs/topics/signing.txt')
-rw-r--r--docs/topics/signing.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/topics/signing.txt b/docs/topics/signing.txt
index 480af18db7..75f066837c 100644
--- a/docs/topics/signing.txt
+++ b/docs/topics/signing.txt
@@ -74,8 +74,10 @@ generate signatures. You can use a different secret by passing it to the
.. class:: Signer(key=None, sep=':', salt=None)
- Returns a signer which uses ``key`` to generate signatures and ``sep``
- to separate values.
+ Returns a signer which uses ``key`` to generate signatures and ``sep`` to
+ separate values. ``sep`` cannot be in the `URL safe base64 alphabet
+ <http://tools.ietf.org/html/rfc4648#section-5>`_. This alphabet contains
+ alphanumeric characters, hyphens, and underscores.
Using the salt argument
-----------------------