Documented the limitation on sep argument to Signer

Co-Authored-By: Gavin Wahl <gwahl@fusionbox.com>
This commit is contained in:
Antoine Catton 2013-10-29 12:36:22 -06:00 committed by Tim Graham
parent 1edef50880
commit e9a356a695
1 changed files with 4 additions and 2 deletions

View File

@ -74,8 +74,10 @@ generate signatures. You can use a different secret by passing it to the
.. class:: Signer(key=None, sep=':', salt=None) .. class:: Signer(key=None, sep=':', salt=None)
Returns a signer which uses ``key`` to generate signatures and ``sep`` Returns a signer which uses ``key`` to generate signatures and ``sep`` to
to separate values. 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 Using the salt argument
----------------------- -----------------------