From d2ad803b5d3901b79f5619eabef8180c5d7ae63e Mon Sep 17 00:00:00 2001 From: meejah Date: Mon, 24 Jun 2019 11:29:34 -0600 Subject: [PATCH] add a docstring for allmydata.crypto. --- src/allmydata/crypto/__init__.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/allmydata/crypto/__init__.py b/src/allmydata/crypto/__init__.py index e69de29bb..3a602bb9a 100644 --- a/src/allmydata/crypto/__init__.py +++ b/src/allmydata/crypto/__init__.py @@ -0,0 +1,8 @@ +""" +Helper functions for cryptograhpy-related operations inside Tahoe + +For the most part, these functions use and return objects that are +documented in the `cryptography` library -- however, code inside Tahoe +should only use these functions and not rely on features of any +objects that `cryptography` documents. +"""