Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / fqdn_rotate.rb

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 879e44b..c86ea68 100644 (file)
--- 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?