Started on documentation

[szyfrow.git] / szyfrow / pocket_enigma.py

diff --git a/szyfrow/pocket_enigma.py b/szyfrow/pocket_enigma.py
index 8590e9b46aa9991cbebdd3d4deffeb97c51ecd75..e3be76871fdc73e28f027021ab9f1f3233a6728a 100644 (file)
--- a/szyfrow/pocket_enigma.py
+++ b/szyfrow/pocket_enigma.py
@@ -1,3 +1,8 @@
+"""The Pocket Enigma machine, a simple example that illustrates the mechanisms
+of the Enigma machine. See [a review](http://www.savory.de/pocket_enigma.htm)
+for more information about the machine.
+"""
+
 from szyfrow.support.utilities import *
 from szyfrow.support.language_models import *