Add documentation for printSizeHumanReadable

2016-02-09 21:44:45 +01:00 · 2016-02-09 21:44:45 +01:00 · d7a0f49391
parent ca6cbaa0b6
commit d7a0f49391
1 changed files with 3 additions and 0 deletions
--- a/functions/utilities.zsh
+++ b/functions/utilities.zsh
@ -27,6 +27,9 @@ function set_default() {
 }

 # Converts large memory values into a human-readable unit (e.g., bytes --> GB)
+# Takes two arguments:
+#   * $size - The number which should be prettified
+#   * $base - The base of the number (default Bytes)
 printSizeHumanReadable() {
  typeset -F 2 size
  size="$1"+0.00001