summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/validate_array.rb
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-12-30 10:46:57 -0800
committerJeff McCune <jeff@puppetlabs.com>2011-12-30 10:46:57 -0800
commit7aeeae3721f105d99a5cdd2e8110315791fd40bd (patch)
tree679b54fc45b775f0fdc705b28e4a5f1f923f803c /lib/puppet/parser/functions/validate_array.rb
parentaa9948bfb32c4d88a04f24586224b628b5be0c8d (diff)
parentbdba42dbb6328ccc5bb13f0777240fdb85e538ca (diff)
Merge branch 'v2.x'
* v2.x: Docs: Clarify the use case for the anchor type Docs: Remove author emails from stdlib functions Docs: Copyedit function doc strings Docs: Correct indentation of markdown code examples Docs: Update documentation of stdlib classes Docs: Update file_line documentation Docs: Improve example in merge function
Diffstat (limited to 'lib/puppet/parser/functions/validate_array.rb')
-rw-r--r--lib/puppet/parser/functions/validate_array.rb10
1 files changed, 4 insertions, 6 deletions
diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb
index a7a7165..34b5118 100644
--- a/lib/puppet/parser/functions/validate_array.rb
+++ b/lib/puppet/parser/functions/validate_array.rb
@@ -1,17 +1,15 @@
module Puppet::Parser::Functions
newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args|
- Validate all passed values are a Array data structure
- value does not pass the check.
+ Validate that all passed values are array data structures. Abort catalog
+ compilation if any value fails this check.
- Example:
-
- These values validate
+ The following values will pass:
$my_array = [ 'one', 'two' ]
validate_array($my_array)
- These values do NOT validate
+ The following values will fail, causing compilation to abort:
validate_array(true)
validate_array('some_string')