diff options
author | EuAndreh <eu@euandre.org> | 2022-08-12 18:46:42 -0300 |
---|---|---|
committer | EuAndreh <eu@euandre.org> | 2022-08-12 18:46:42 -0300 |
commit | c0ed55485e8db03673318f67dd06e7a04435c0f9 (patch) | |
tree | 932fc598a77c8c0fd39cfc17242ea3f970e6c5d8 /bin | |
parent | etc/git/ignore: Always exclude tmp/ directory (diff) | |
download | dotfiles-c0ed55485e8db03673318f67dd06e7a04435c0f9.tar.gz dotfiles-c0ed55485e8db03673318f67dd06e7a04435c0f9.tar.xz |
bin/{min,max,clamp}: Add "Examples" section to help string
Diffstat (limited to 'bin')
-rwxr-xr-x | bin/clamp | 19 | ||||
-rwxr-xr-x | bin/max | 23 | ||||
-rwxr-xr-x | bin/min | 24 |
3 files changed, 66 insertions, 0 deletions
@@ -15,7 +15,26 @@ help() { Options: -h, --help show this message + Clamp the NUMBER between MIN and MAX. + + + Examples: + + Assert the number is within the interval: + + $ clamp 5 3 9 + 5 + + When a number is below MIN it gets clamped: + + $ clamp 1 3 9 + 3 + + When a number is above MAX it gets clamped: + + $ clamp 15 3 9 + 9 EOF } @@ -16,6 +16,29 @@ help() { -h, --help show this message Get the maximum number from the given values. + + + Examples: + + Get the maximum number from a list: + + $ min 5 3 9 9 4 + 9 + + Get the maximum number when negative numbers are given + + $ max -- -3 -5 + -3 + + Get the maximum number given a single number + + $ max 8 + 8 + + The maximum default number: + + $ max + 0 EOF } @@ -15,7 +15,31 @@ help() { Options: -h, --help show this message + Get the minimun number from the given values. + + + Examples: + + Get the minimum number from a list: + + $ min 5 3 9 9 4 + 3 + + Get the minimum number when negative numbers are given + + $ min -- -3 -5 + -5 + + Get the minimum number given a single number + + $ min 8 + 8 + + The minimum default number: + + $ min + 0 EOF } |