summaryrefslogtreecommitdiff
path: root/functions/utilities.zsh
diff options
context:
space:
mode:
authorDominik Ritter <dritter03@googlemail.com>2016-02-09 23:44:45 +0300
committerDominik Ritter <dritter03@googlemail.com>2016-02-12 03:18:35 +0300
commitd7a0f493912ecdfe117c7e67fac0a355f34bb4a4 (patch)
treeb7ed032f94a5e3f6e5a328abfd2c1a7d44b53562 /functions/utilities.zsh
parentca6cbaa0b663b580c62d3187616af4d0aed79758 (diff)
Add documentation for printSizeHumanReadable
Diffstat (limited to 'functions/utilities.zsh')
-rw-r--r--functions/utilities.zsh3
1 files changed, 3 insertions, 0 deletions
diff --git a/functions/utilities.zsh b/functions/utilities.zsh
index 079e675a..7ca73b36 100644
--- 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