Describe memory values.

irares · Apr 7, 2017 · fbf01a6 · fbf01a6
1 parent b0f1430
commit fbf01a6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/documentation/source/parameter-reference.rst b/documentation/source/parameter-reference.rst
@@ -12,6 +12,10 @@ The default values below will vary based on the input data type and genome size.
 
 Boolean options accept true/false or 1/0.
 
+Memory sizes are assumed to be in gigabytes if no units are supplied.  Values may be non-integer
+with or without a unit - 'k' for kilobytes, 'm' for megabytes, 'g' for gigabytes or 't' for
+terabytes.  For example, "0.25t" is equivalent to "256g" (or simply "256").
+
 Global Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~