documentation fixes

glennmatthews · Mar 6, 2015 · 37f5966 · 37f5966
1 parent 1e99cec
commit 37f5966
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/COT/helper_tools.py b/COT/helper_tools.py
@@ -207,7 +207,7 @@ def create_disk_image(file_path, file_format=None,
     :param str file_format: Desired image format (if not specified, this will
       be derived from the file extension of :attr:`file_path`)
 
-    :param capacity: TODO what's the expected format?
+    :param capacity: Disk capacity. A string like '16M' or '1G'.
     :param list contents: List of file paths to package into the created image.
       If not specified, the image will be left blank and unformatted.
     """

diff --git a/COT/helpers/fatdisk.py b/COT/helpers/fatdisk.py
@@ -95,7 +95,7 @@ def create_raw_image(self, file_path, contents, capacity=None):
         :param str file_path: Desired location of new disk image
         :param list contents: List of file paths to package into the created
           image.
-        :param capacity: TODO what's the expected format?
+        :param capacity: (optional) Disk capacity. A string like '16M' or '1G'.
         """
         if not capacity:
             # What size disk do we need to contain the requested file(s)?

diff --git a/COT/helpers/qemu_img.py b/COT/helpers/qemu_img.py
@@ -168,7 +168,7 @@ def create_blank_disk(self, file_path, capacity, file_format=None):
         """Create an unformatted disk image at the requested location.
 
         :param str file_path: Desired location of new disk image
-        :param capacity: TODO what's the expected format?
+        :param capacity: Disk capacity. A string like '16M' or '1G'.
         :param str file_format: Desired image format (if not specified, this
           will be derived from the file extension of :attr:`file_path`)
         """