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_bool.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_bool.rb')
| -rw-r--r-- | lib/puppet/parser/functions/validate_bool.rb | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 49e6378..62c1d88 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -1,27 +1,22 @@ module Puppet::Parser::Functions newfunction(:validate_bool, :doc => <<-'ENDHEREDOC') do |args| - Validate all passed values are true or false. Abort catalog compilation if the - value does not pass the check. + Validate that all passed values are either true or false. Abort catalog + compilation if any value fails this check. - Example: - - These booleans validate + The following values will pass: $iamtrue = true validate_bool(true) validate_bool(true, true, false, $iamtrue) - These strings do NOT validate and will abort catalog compilation + The following values will fail, causing compilation to abort: $some_array = [ true ] validate_bool("false") validate_bool("true") validate_bool($some_array) - * Jeff McCune <jeff@puppetlabs.com> - * Dan Bode <dan@puppetlabs.com> - ENDHEREDOC unless args.length > 0 then |