Browse Source

Documented the limitation on sep argument to Signer

Co-Authored-By: Gavin Wahl <gwahl@fusionbox.com>
Antoine Catton 11 years ago
parent
commit
e9a356a695
1 changed files with 4 additions and 2 deletions
  1. 4 2
      docs/topics/signing.txt

+ 4 - 2
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
 -----------------------