X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fis_float.rb;h=583793d010ad26b0a4cf312027eb777f499789cb;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=a2da94385be23590e69414dc5c8a19253c839951;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_float.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_float.rb index a2da94385..583793d01 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_float.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_float.rb @@ -1,29 +1,33 @@ # # is_float.rb # - module Puppet::Parser::Functions - newfunction(:is_float, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a float. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_float(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + newfunction(:is_float, :type => :rvalue, :doc => <<-DOC + @summary + **Deprecated:** Returns true if the variable passed to this function is a float. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). + DOC + ) do |arguments| + + function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) + + if arguments.size != 1 + raise(Puppet::ParseError, "is_float(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] # Only allow Numeric or String types - return false unless value.is_a?(Numeric) or value.is_a?(String) - - if value != value.to_f.to_s and !value.is_a? Float then - return false - else - return true - end + return false unless value.is_a?(Numeric) || value.is_a?(String) + return false if value != value.to_f.to_s && !value.is_a?(Float) + return true end end