refactor do_something in linef

[imago.git] / imago_pack / im_debug.py

diff --git a/imago_pack/im_debug.py b/imago_pack/im_debug.py
index 9916e92..d04144a 100644 (file)
--- a/imago_pack/im_debug.py
+++ b/imago_pack/im_debug.py
@@ -1,3 +1,9 @@
+"""Debugging image display.
+
+This is a simple module, that shows images on screen using PyGame.
+It is not used anywhere in the standard UI, serves only for debugging.
+"""
+
 try:
     import pygame
 except ImportError, msg:
@@ -6,6 +12,7 @@ except ImportError, msg:
     sys.exit(1)
 
 def show(image, caption='', name=None):
+    """Initialize PyGame and show the *image*."""
     if image.mode != 'RGB':
         image = image.convert('RGB')
     pygame.init()