#
# is_array.rb
#
-
module Puppet::Parser::Functions
- newfunction(:is_array, :type => :rvalue, :doc => <<-EOS
-Returns true if the variable passed to this function is an array.
- EOS
- ) do |arguments|
+ newfunction(:is_array, :type => :rvalue, :doc => <<-DOC
+ @summary
+ **Deprecated:** Returns true if the variable passed to this function is an array.
+
+ @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|
- raise(Puppet::ParseError, "is_array(): Wrong number of arguments " +
- "given (#{arguments.size} for 1)") if arguments.size < 1
+ function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function,
+ with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.'])
+
+ raise(Puppet::ParseError, "is_array(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
type = arguments[0]
return result
end
end
-
-# vim: set ts=2 sw=2 et :