From b7990264e8675511e4a4e77cbbd1f16363839ad7 Mon Sep 17 00:00:00 2001 From: meejah Date: Mon, 24 Jun 2019 11:41:26 -0600 Subject: [PATCH] module docstring --- src/allmydata/crypto/aes.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/allmydata/crypto/aes.py b/src/allmydata/crypto/aes.py index 5f5aab40a..dd496e6bd 100644 --- a/src/allmydata/crypto/aes.py +++ b/src/allmydata/crypto/aes.py @@ -1,3 +1,13 @@ +""" +Helper functions for cryptograhpy-related operations inside Tahoe +using AES + +These functions use and return objects that are documented in the +`cryptography` library -- however, code inside Tahoe should only use +functions from allmydata.crypto.aes and not rely on features of any +objects that `cryptography` documents. +""" + import six from cryptography.hazmat.backends import default_backend