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:23 -0400 |
| commit | e21d935f52980aefc972e11c9bd551dd75b1a659 (patch) | |
| tree | b7dbe8312c5fd6d34ca0515c1022403a38ce6d8e | |
| parent | f832f0d2c309ac31bbf3616c34495c48509b0fb3 (diff) | |
[1.5.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 3da70da679..0d001e74c6 100644 --- a/docs/topics/signing.txt +++ b/docs/topics/signing.txt @@ -76,8 +76,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 ----------------------- |