summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/validate_hash.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/parser/functions/validate_hash.rb')
-rw-r--r--lib/puppet/parser/functions/validate_hash.rb10
1 files changed, 4 insertions, 6 deletions
diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb
index 1443318..1b1c854 100644
--- a/lib/puppet/parser/functions/validate_hash.rb
+++ b/lib/puppet/parser/functions/validate_hash.rb
@@ -1,17 +1,15 @@
module Puppet::Parser::Functions
newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args|
- Validate all passed values are a Hash data structure
- value does not pass the check.
+ Validate that all passed values are hash data structures. Abort catalog
+ compilation if any value fails this check.
- Example:
-
- These values validate
+ The following values will pass:
$my_hash = { 'one' => 'two' }
validate_hash($my_hash)
- These values do NOT validate
+ The following values will fail, causing compilation to abort:
validate_hash(true)
validate_hash('some_string')