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%2Ffqdn_rotate.rb;h=c86ea6829c0ff2cd98379dfeba3ae2f19cd27233;hp=879e44bbc3336468618a8016233b4bb1af167be8;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rotate.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rotate.rb
index 879e44bbc..c86ea6829 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rotate.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rotate.rb
@@ -4,15 +4,19 @@
 Puppet::Parser::Functions.newfunction(
   :fqdn_rotate,
   :type => :rvalue,
-  :doc => "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and
-  must be an array or a string. SEED is optional and may be any number
-  or string.
-
-  Rotates VALUE a random number of times, combining the `$fqdn` fact and
-  the value of SEED for repeatable randomness. (That is, each node will
-  get a different random rotation from this function, but a given node's
-  result will be the same every time unless its hostname changes.) Adding
-  a SEED can be useful if you need more than one unrelated rotation.",
+  :doc => <<-DOC
+  @summary
+    Rotates an array or string a random number of times, combining the `$fqdn` fact
+    and an optional seed for repeatable randomness.
+
+  @return
+    rotated array or string
+
+  @example Example Usage:
+    fqdn_rotate(['a', 'b', 'c', 'd'])
+    fqdn_rotate('abcd')
+    fqdn_rotate([1, 2, 3], 'custom seed')
+  DOC
 ) do |args|
 
   raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty?