aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-10-31 10:35:19 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2013-10-31 10:35:19 -0700
commitde475eb9f56a34868c7debb707427ab5678eda6c (patch)
tree69dfce229ee267af7db8594b8817a7b140b74dc1 /docs
parent333fb1024e20fa10ec3e85cbd196cbdff059000d (diff)
downloadcryptography-de475eb9f56a34868c7debb707427ab5678eda6c.tar.gz
cryptography-de475eb9f56a34868c7debb707427ab5678eda6c.tar.bz2
cryptography-de475eb9f56a34868c7debb707427ab5678eda6c.zip
Improve the docs
Diffstat (limited to 'docs')
-rw-r--r--docs/fernet.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/fernet.rst b/docs/fernet.rst
index 938ba0cb..ac610eb8 100644
--- a/docs/fernet.rst
+++ b/docs/fernet.rst
@@ -22,6 +22,9 @@ using it cannot be manipulated or read without the key.
>>> from cryptography.fernet import Fernet
>>> f = Fernet(key)
>>> ciphertext = f.encrypt(b"my deep dark secret")
+ # Secret bytes.
+ >>> ciphertext
+ '...'
>>> f.decrypt(ciphertext)
'my deep dark secret'
@@ -33,7 +36,7 @@ using it cannot be manipulated or read without the key.
:param bytes plaintext: The message you would like to encrypt.
:returns bytes: A secure message which cannot be read or altered
- without the key.
+ without the key. It is URL safe base64-encoded.
.. method:: decrypt(ciphertext, ttl=None)