]> gitweb.factorcode.org Git - factor.git/commitdiff
random: minor doc improvement with $snippet.
authorJohn Benediktsson <mrjbq7@gmail.com>
Mon, 11 Sep 2017 22:47:39 +0000 (15:47 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Mon, 11 Sep 2017 22:47:39 +0000 (15:47 -0700)
basis/random/random-docs.factor

index d716fe1eff137737a00f8028b8ca5d7dd33e7717..fab1253a2ef3715342a92629ec0d071cc2f19e4e 100644 (file)
@@ -16,7 +16,7 @@ HELP: random-32*
 
 HELP: random-bytes*
 { $values { "n" integer } { "obj" "a random number generator" } { "byte-array" "a sequence of random bytes" } }
-{ $description "Generates a byte-array of n random bytes." } ;
+{ $description "Generates a byte-array of " { $snippet "n" } " random bytes." } ;
 
 HELP: random
 { $values { "obj" object } { "elt" "a random element" } }
@@ -38,7 +38,7 @@ HELP: random-32
 
 HELP: random-bytes
 { $values { "n" integer } { "byte-array" "a sequence of random bytes" } }
-{ $description "Generates a byte-array of n random bytes." }
+{ $description "Generates a byte-array of " { $snippet "n" } " random bytes." }
 { $examples
     { $unchecked-example "USING: prettyprint random ;"
                "5 random-bytes ."
@@ -80,11 +80,11 @@ HELP: random-units
 
 HELP: random-bits
 { $values { "numbits" integer } { "n" "a random integer" } }
-{ $description "Outputs an random integer n bits in length." } ;
+{ $description "Outputs a random integer " { $snippet "numbits" } " bits in length." } ;
 
 HELP: random-bits*
 { $values { "numbits" integer } { "n" "a random integer" } }
-{ $description "Returns an integer exactly " { $snippet "numbits" } " in length, with the topmost bit set to one." } ;
+{ $description "Returns an integer exactly " { $snippet "numbits" } " bits in length, with the topmost bit set to one." } ;
 
 HELP: with-random
 { $values { "obj" "a random number generator" } { "quot" quotation } }