#
# values.rb
#
-
module Puppet::Parser::Functions
- newfunction(:values, :type => :rvalue, :doc => <<-EOS
-When given a hash this function will return the values of that hash.
+ newfunction(:values, :type => :rvalue, :doc => <<-DOC
+ @summary
+ When given a hash this function will return the values of that hash.
+
+ @return
+ array of values
-*Examples:*
+ @example **Usage**
+ $hash = {
+ 'a' => 1,
+ 'b' => 2,
+ 'c' => 3,
+ }
+ values($hash)
- $hash = {
- 'a' => 1,
- 'b' => 2,
- 'c' => 3,
- }
- values($hash)
+ This example would return: ```[1,2,3]```
-This example would return:
+ > *Note:*
+ From Puppet 5.5.0, the compatible function with the same name in Puppet core
+ will be used instead of this function.
- [1,2,3]
- EOS
- ) do |arguments|
+ DOC
+ ) do |arguments|
- raise(Puppet::ParseError, "values(): Wrong number of arguments " +
- "given (#{arguments.size} for 1)") if arguments.size < 1
+ raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
hash = arguments[0]