Started on documentation

[szyfrow.git] / szyfrow / polybius.py

diff --git a/szyfrow/polybius.py b/szyfrow/polybius.py
index b3ffeaba91e9fb722a9b9004abc481692887a1f3..d037ec9c0b212d03784fe64744f0c42eeb08c64a 100644 (file)
--- a/szyfrow/polybius.py
+++ b/szyfrow/polybius.py
@@ -1,3 +1,7 @@
+"""Simple digraph substitution cipher, using the 
+[Polybius square](https://en.wikipedia.org/wiki/Polybius_square). Enciphering
+and deciphering, and a couple of ways to break these ciphers.
+"""
 import multiprocessing 
 from szyfrow.support.utilities import *
 from szyfrow.support.language_models import *
@@ -60,7 +64,6 @@ def polybius_encipher(message, keyword, column_order, row_order,
     """Encipher a message with Polybius cipher, using a keyword to rearrange
     the alphabet
 
-
     >>> polybius_encipher('this is a test message for the ' \
           'polybius decipherment', 'elephant', \
           [1, 2, 3, 4, 5], [1, 2, 3, 4, 5], \