[doc] document public methods

1 files changed, 12 insertions, 0 deletions

diff --git a/memoryhole/__init__.py b/memoryhole/__init__.py
index 5cd55b6..fd621ea 100644
--- a/memoryhole/__init__.py
+++ b/memoryhole/__init__.py
@@ -8,6 +8,18 @@ OBSCURED_HEADERS = ('Subject', 'Message-ID', 'Date', 'To', 'From')
 
 
 def unwrap(msg, opengp=Gnupg()):
+    """
+    Unwrap an email replacing and verifying memory hole headers.
+
+    :param msg: the email to be unwrapped
+    :type msg: Message
+    :param openpgp: the implementation of openpgp to use for decryption and/or
+                    verification
+    :type openpgp: OpenPGP
+
+    :return: a dencrypted email
+    :rtype: Message
+    """
     raise NotImplementedError()