X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fis_function_available.rb;h=e931225c43e6d8c560106809d2f66b43c3bb34da;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=6da82c8c1706eebdcaf878f3f25785477418e2a6;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_function_available.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_function_available.rb index 6da82c8c1..e931225c4 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_function_available.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_function_available.rb @@ -1,25 +1,30 @@ # # is_function_available.rb # - module Puppet::Parser::Functions - newfunction(:is_function_available, :type => :rvalue, :doc => <<-EOS -This function accepts a string as an argument, determines whether the -Puppet runtime has access to a function by that name. It returns a -true if the function exists, false if not. - EOS - ) do |arguments| + newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC + @summary + **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. + + This function accepts a string as an argument. + + @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| - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + if arguments.size != 1 + raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments given #{arguments.size} for 1") end # Only allow String types return false unless arguments[0].is_a?(String) function = Puppet::Parser::Functions.function(arguments[0].to_sym) - function.is_a?(String) and not function.empty? + function.is_a?(String) && !function.empty? end end