Mercurial > repos > other > Puppet
diff modules/stdlib/lib/puppet/parser/functions/any2bool.rb @ 275:d9352a684e62
Mass update of modules to remove deprecation warnings
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sun, 26 Jan 2020 11:36:07 +0000 |
parents | c42fb28cff86 |
children | adf6fe9bbc17 |
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/parser/functions/any2bool.rb Sat Jan 04 11:42:45 2020 +0000 +++ b/modules/stdlib/lib/puppet/parser/functions/any2bool.rb Sun Jan 26 11:36:07 2020 +0000 @@ -3,14 +3,21 @@ # module Puppet::Parser::Functions newfunction(:any2bool, :type => :rvalue, :doc => <<-DOC - This converts 'anything' to a boolean. In practise it does the following: + @summary + Converts 'anything' to a boolean. + In practise it does the following: * Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true * Strings such as 0,F,f,N,n,FALSE,no,'false' will return false * Booleans will just return their original value * Number (or a string representation of a number) > 0 will return true, otherwise false * undef will return false * Anything else will return true + + Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) + function. + + @return [Boolean] The boolean value of the object that was given DOC ) do |arguments|