diff options
| author | David Reid <dreid@dreid.org> | 2013-10-22 14:09:19 -0700 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2013-10-22 14:09:19 -0700 |
| commit | 63ba6654bc032c270a20035767a20837899b82bc (patch) | |
| tree | aef6127c8de5f81454a2de80807bdc3b791634c0 /docs/primitives | |
| parent | f54ffd4dfa382dc3742657c146e028498740de9a (diff) | |
| download | cryptography-63ba6654bc032c270a20035767a20837899b82bc.tar.gz cryptography-63ba6654bc032c270a20035767a20837899b82bc.tar.bz2 cryptography-63ba6654bc032c270a20035767a20837899b82bc.zip | |
Don't try to fit the type into the :return: declaration instead describe it in the prose where it'll be properly linked.
Diffstat (limited to 'docs/primitives')
| -rw-r--r-- | docs/primitives/symmetric-encryption.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/primitives/symmetric-encryption.rst b/docs/primitives/symmetric-encryption.rst index 73d8ad37..9768246c 100644 --- a/docs/primitives/symmetric-encryption.rst +++ b/docs/primitives/symmetric-encryption.rst @@ -33,11 +33,15 @@ where the encrypter and decrypter both use the same key. .. method:: encryptor() - :return :class:`CipherContext`: encryption instance + :return: An encrypting + :class:`~cryptography.primitives.interfaces.CipherContext` + provider. .. method:: decryptor() - :return :class:`CipherContext`: decryption instance + :return: A decrypting + :class:`~cryptography.primitives.interfaces.CipherContext` + provider. .. class:: cryptography.primitives.interfaces.CipherContext() |