diff options
| author | Jeff McCune <jeff@puppetlabs.com> | 2011-08-18 13:45:28 -0700 |
|---|---|---|
| committer | Jeff McCune <jeff@puppetlabs.com> | 2011-08-18 13:45:28 -0700 |
| commit | bdba42dbb6328ccc5bb13f0777240fdb85e538ca (patch) | |
| tree | de11ef579d7ffec6c7161945da5e84b75287d629 /lib/puppet/parser/functions/validate_hash.rb | |
| parent | ad5316f561475157e425a7fddf1365e8e89b2b9d (diff) | |
| parent | 8e770b04234aacfc09c7b8ad45ffa304cb83f723 (diff) | |
| download | puppet-stdlib-bdba42dbb6328ccc5bb13f0777240fdb85e538ca.tar.gz puppet-stdlib-bdba42dbb6328ccc5bb13f0777240fdb85e538ca.tar.bz2 | |
Merge pull request #16 from nfagerlund/docs/v2.0.0/XXXX_function_doc_updates
Docs/v2.0.0/xxxx function doc updates
Diffstat (limited to 'lib/puppet/parser/functions/validate_hash.rb')
| -rw-r--r-- | lib/puppet/parser/functions/validate_hash.rb | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 1443318..9bdd543 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -1,25 +1,21 @@ 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') $undefined = undef validate_hash($undefined) - * Jeff McCune <jeff@puppetlabs.com> - ENDHEREDOC unless args.length > 0 then |