X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fjoin_keys_to_values.rb;h=73d4a1ff05dced93cdd9d086bc080872114dfdff;hp=99876d023ac21beb3518f195cb0b8d0590bbd005;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/join_keys_to_values.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/join_keys_to_values.rb
index 99876d023..73d4a1ff0 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/join_keys_to_values.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/join_keys_to_values.rb
@@ -3,22 +3,22 @@
 #
 module Puppet::Parser::Functions
   newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-DOC
-    This function joins each key of a hash to that key's corresponding value with a
-    separator. Keys are cast to strings. If values are arrays, multiple keys
+    @summary
+      This function joins each key of a hash to that key's corresponding value with a
+      separator.
+
+    Keys are cast to strings. If values are arrays, multiple keys
     are added for each element. The return value is an array in
     which each element is one joined key/value pair.
 
-    *Examples:*
-
-        join_keys_to_values({'a'=>1,'b'=>2}, " is ")
-
-    Would result in: ["a is 1","b is 2"]
-
-        join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")
+    @example Example Usage:
+      join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"]
+      join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"]
 
-    Would result in: ["a is 1","b is 2","b is 3"]
+    @return [Hash]
+      The joined hash
 
-    Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and
+    > **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and
     line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual
     formatting of values in the array) - see the `new` function for `String` and its formatting
     options for `Array` and `Hash`.