From 0656a0e284ed94f8c195592d62e9232e3c6d04b7 Mon Sep 17 00:00:00 2001 From: Marc Huffnagle Date: Fri, 5 Oct 2012 11:07:01 -0400 Subject: Added additional documentation to the check_range function --- plugins-scripts/utils.sh.in | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/plugins-scripts/utils.sh.in b/plugins-scripts/utils.sh.in index 5fae6adb..4a07df89 100644 --- a/plugins-scripts/utils.sh.in +++ b/plugins-scripts/utils.sh.in @@ -23,7 +23,16 @@ support() { # # check_range takes a value and a range string, returning successfully if an -# alert should be raised based on the range. +# alert should be raised based on the range. Range values are inclusive. +# Values may be integers or floats. +# +# Example usage: +# +# Generating an exit code of 1: +# check_range 5 2:8 +# +# Generating an exit code of 0: +# check_range 1 2:8 # check_range() { local v range yes no err decimal start end cmp match -- cgit v1.2.3-74-g34f1