Commit a16ad528 authored by Merlijn Wajer's avatar Merlijn Wajer
Browse files

imagestack: update documentation some more

parent 35cb5af5
......@@ -41,6 +41,10 @@ def unpack_and_validate_imagestack(imagestack_path, imagestack_info, dst):
An imagestack is valid if it contains at least one directory that contains
at least one image of the expected image type.
Unless you need all the images written to disk (which could be slow and take
up space), it would be better to look at the iterate_imagestack and
validate_imagestack methods in this module.
Args:
* imagestack_path (``str``): The imagestack archive path
......@@ -87,7 +91,8 @@ def iterate_imagestack(imagestack_path, imagestack_info, sort=True):
"""Unpack and validate an imagestack
An imagestack is valid if it contains at least one directory that contains
at least one image of the expected image type.
at least one image of the expected image type. All operations are done
without writing to the disk.
Args:
......@@ -149,7 +154,8 @@ 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.
at least image with a supported image type. All operations are done without
writing to the disk.
Args:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment