From f60f13c675875ab56e82e9c787ea5021b9256190 Mon Sep 17 00:00:00 2001 From: Jon Harper Date: Tue, 2 Nov 2010 17:23:54 +0100 Subject: [PATCH] math.primes.erato doc fixes. --- basis/math/primes/erato/erato-docs.factor | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/basis/math/primes/erato/erato-docs.factor b/basis/math/primes/erato/erato-docs.factor index 75e3846dc1..b9d9ea38df 100644 --- a/basis/math/primes/erato/erato-docs.factor +++ b/basis/math/primes/erato/erato-docs.factor @@ -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 } "." } ;