]> gitweb.factorcode.org Git - factor.git/commitdiff
math.primes.erato doc fixes.
authorJon Harper <jon.harper87@gmail.com>
Tue, 2 Nov 2010 16:23:54 +0000 (17:23 +0100)
committerSamuel Tardieu <sam@rfc1149.net>
Tue, 2 Nov 2010 16:34:28 +0000 (17:34 +0100)
basis/math/primes/erato/erato-docs.factor

index 75e3846dc11a7238c1c104f7fb42db1bbd4927a9..b9d9ea38df72d078e5b2b704f30c2f49e6220a07 100644 (file)
@@ -1,10 +1,14 @@
-USING: help.markup help.syntax ;
+USING: byte-arrays help.markup help.syntax kernel math ;
 IN: math.primes.erato
 
 HELP: sieve
-{ $values { "n" "the greatest odd number to consider" } { "arr" "a bit array" } }
-{ $description "Apply Eratostene sieve up to " { $snippet "n" } ". Primality can then be tested using " { $link marked-prime? } "." } ;
+{ $values { "n" integer } { "arr" byte-array } }
+{ $description "Apply Eratostene sieve up to " { $snippet "n" }
+". " { $snippet "n" } " must be greater than 1"
+". Primality can then be tested using " { $link marked-prime? } "." } ;
 
 HELP: marked-prime?
-{ $values { "n" "an integer" } { "arr" "a byte array returned by " { $link sieve } } { "?" "a boolean" } }
-{ $description "Check whether an odd integer between 3 and the limit given to " { $link sieve } " has been marked as a prime number."} ;
+{ $values { "n" integer } { "arr" byte-array } { "?" boolean } }
+{ $description "Checks whether " { $snippet "n" } " has been marked as a prime number. "
+{ $snippet "arr" } " must be " { $instance byte-array } " returned by " { $link sieve } ". "
+{ $snippet "n" } " must be between 2 and the limit given to " { $link sieve } "." } ;