Mercurial > repos > other > Puppet

diff modules/stdlib/lib/puppet/parser/functions/seeded_rand.rb @ 275:d9352a684e62

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Mass update of modules to remove deprecation warnings
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Jan 2020 11:36:07 +0000
parents c42fb28cff86
children 4a2ee7e3b110
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/parser/functions/seeded_rand.rb	Sat Jan 04 11:42:45 2020 +0000
+++ b/modules/stdlib/lib/puppet/parser/functions/seeded_rand.rb	Sun Jan 26 11:36:07 2020 +0000
@@ -6,7 +6,15 @@
   :arity => 2,
   :type => :rvalue,
   :doc => <<-DOC
-    Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string.
+    @summary
+      Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness.
+
+    @return
+      random number greater than or equal to 0 and less than MAX
+
+    @example **Usage:**
+      seeded_rand(MAX, SEED).
+      MAX must be a positive integer; SEED is any string.
 
     Generates a random whole number greater than or equal to 0 and less
     than MAX, using the value of SEED for repeatable randomness.  If SEED