Minor documentation updates

[szyfrow.git] / szyfrow / autokey.py

diff --git a/szyfrow/autokey.py b/szyfrow/autokey.py
index 11bfa6bdea506fc51e78e6ccfee2a3a46cefae75..b9e2184275c6a68e898ce42f5b0fa625bd362af8 100644 (file)
--- a/szyfrow/autokey.py
+++ b/szyfrow/autokey.py
@@ -1,3 +1,6 @@
+"""Enciphering and deciphering using the [Autokey cipher](https://en.wikipedia.org/wiki/Autokey_cipher). 
+Also attempts to break messages that use a Autokey cipher.
+"""
 import math
 import multiprocessing 
 from szyfrow.support.utilities import *
@@ -30,7 +33,6 @@ def autokey_decipher(ciphertext, keyword):
     return cat(plaintext)
 
 
-
 def autokey_sa_break( message
                     , min_keylength=2
                     , max_keylength=20