diff options
author | Jeff McCune <jeff@puppetlabs.com> | 2011-12-30 11:48:21 -0800 |
---|---|---|
committer | Jeff McCune <jeff@puppetlabs.com> | 2011-12-30 11:48:21 -0800 |
commit | 80c9a8feeae6203026f61215e100e95078c61a04 (patch) | |
tree | e70920f96b88bdc9e985e2439f395371d5ffe2be /lib/puppet/parser/functions/validate_hash.rb | |
parent | 1434f3cea6f6e2a1b939d91cb5ff66338cc87d32 (diff) | |
parent | a8d4bbd9e234ea577e27d83df95a61b374ac484b (diff) | |
download | puppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.gz puppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.bz2 |
Merge branch 'v2.1.x' into v2.2.x
* v2.1.x:
(maint) Add semantic versioning info to README
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_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 |