imagestack: document validate_imagestack

derivermodule/imagestack.py

@@ -147,6 +147,19 @@ def iterate_imagestack(imagestack_path, imagestack_info, sort=True):
 
 
 def validate_imagestack(imagestack_path, imagestack_info):
+    """
+    Validate an imagestack given a path. An imagestack is valid if it contains
+    at least image with a supported image type.
+
+    Args:
+
+    * imagestack_path (``str``): The imagestack archive path
+    * imagestack_info (``dict``)::
+
+        >>> {'archive_type': ..., 'image_type': ...}
+
+    If the method does not raise an Exception, the image stack is valid.
+    """
     image_count = 0
 
     for img_path, _ in iterate_imagestack(imagestack_path, imagestack_info):