summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2014-04-15 20:34:54 +0200
committerGuido Günther <agx@sigxcpu.org>2014-04-15 21:29:38 +0200
commit6150e33e8c377089d7f05f18df015921dcc5e09d (patch)
tree22b6d6226bdd4b7f28afc76de5bc71205ea259b3 /README.markdown
parentc0eab58bc6bcfb26275349d817bf8746902a221a (diff)
Add validate_nonemptyarray
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown
index 447ef7f..fb8298e 100644
--- a/README.markdown
+++ b/README.markdown
@@ -7,8 +7,9 @@ of the standard library. It's called "stdlib minus minus".
validate_nonemptystring
-----------------------
-Validate that all passed values are strings with a length greater 0 and not undef. Abort catalog
-compilation if any value fails this check.
+Validate that all passed values are strings with a length greater 0
+and not undef. Abort catalog compilation if any value fails this
+check.
The following values will pass:
@@ -22,3 +23,22 @@ The following values will fail, causing compilation to abort:
$undefined = undef
validate_nonemptystring($undefined)
+validate_nonemptyarray
+----------------------
+Validate that all passed values are array data structures. Abort
+catalog compilation if any value fails this check. Also abort if any
+of the arrays is empty.
+
+The following values will pass:
+
+ $my_array = [ 'one', 'two' ]
+ validate_nonemptyarray($my_array)
+
+The following values will fail, causing compilation to abort:
+
+ validate_nonemptyarray(true)
+ validate_nonemptyarray([])
+ validate_nonemptyarray('some_string')
+ $undefined = undef
+ validate_nonemptyarray($undefined)
+