diff options
| author | Antoine Catton <acatton@fusionbox.com> | 2013-10-29 12:36:22 -0600 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-10-30 08:27:19 -0400 |
| commit | 142757c61ef750faa1cb135f06847e289ebaa012 (patch) | |
| tree | 88e1d6e11ecf101cb9443070ff72af30a049f890 | |
| parent | da0c7723fa71f7273d5bd917a6aecc4243232a4e (diff) | |
[1.6.x] Documented the limitation on sep argument to Signer
Co-Authored-By: Gavin Wahl <gwahl@fusionbox.com>
Backport of e9a356a695 from master
| -rw-r--r-- | docs/topics/signing.txt | 6 |
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 ----------------------- |