From cb725eb587975617381ab8c7c2d67c842f7a9793 Mon Sep 17 00:00:00 2001 From: Julien Gilli Date: Mon, 3 Apr 2017 18:56:26 -0700 Subject: [PATCH] fix parseVolumeSize comments doc according to latest changes --- lib/volumes.js | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/lib/volumes.js b/lib/volumes.js index bd43ca1..ae27696 100644 --- a/lib/volumes.js +++ b/lib/volumes.js @@ -18,7 +18,16 @@ function throwInvalidSize(size) { /* * Returns the number of MiBs (Mebibytes) represented by the string "size". That - * string can have different format suffixes, such as "100GB", "100G", etc. + * string has the following format: . The integer must be > 0. + * Unit format suffixes are 'G' or 'g' for gibibytes and 'M' or 'm' for + * mebibytes. If no unit suffix is provided, the unit is considered to be + * mebibytes. + * + * Examples: + * - the string '100' represents 100 mebibytes + * - the strings '100g' and '100G' represent 100 gibibytes + * - the string '100' represents 100 mebibytes + * * If "size" is not a valid size string, an error is thrown. */ function parseVolumeSize(size) {