Update to API docs

This commit is contained in:
Helder Eijs 2018-04-03 21:33:15 +02:00
parent 6fd65d491f
commit fc8e6c5eb9
22 changed files with 111 additions and 109 deletions

View file

@ -84,7 +84,7 @@ class Salsa20Cipher:
"""Encrypt a piece of data.
:param plaintext: The data to encrypt, of any size.
:type plaintext: byte string/array
:type plaintext: bytes/bytearray/memoryview
:returns: the encrypted byte string, of equal length as the
plaintext.
"""
@ -103,7 +103,7 @@ class Salsa20Cipher:
"""Decrypt a piece of data.
:param ciphertext: The data to decrypt, of any size.
:type ciphertext: byte string/array
:type ciphertext: bytes/bytearray/memoryview
:returns: the decrypted byte string, of equal length as the
ciphertext.
"""
@ -117,7 +117,7 @@ def new(key, nonce=None):
"""Create a new Salsa20 cipher
:keyword key: The secret key to use. It must be 16 or 32 bytes long.
:type key: byte string
:type key: bytes/bytearray/memoryview
:keyword nonce:
A value that must never be reused for any other encryption
@ -125,7 +125,7 @@ def new(key, nonce=None):
If not provided, a random byte string will be generated (you can read
it back via the ``nonce`` attribute of the returned object).
:type nonce: byte string/array
:type nonce: bytes/bytearray/memoryview
:Return: a :class:`Crypto.Cipher.Salsa20.Salsa20Cipher` object
"""