math: some docs tweaks for gcd and mod-inv

[factor.git] / core / math / math-docs.factor

diff --git a/core/math/math-docs.factor b/core/math/math-docs.factor
index 38319f895fe0b2c8424cb96eab3fe7249750aee0..5f741a94733ee7b4b20c27eb7c6a0b4a49d02e86 100644 (file)
--- a/core/math/math-docs.factor
+++ b/core/math/math-docs.factor
@@ -246,7 +246,11 @@ HELP: >rect
 HELP: gcd
 { $values { "x" integer } { "y" integer } { "a" integer } { "d" integer } }
 { $description "Computes the positive greatest common divisor " { $snippet "d" } " of " { $snippet "x" } " and " { $snippet "y" } ", and another value " { $snippet "a" } " satisfying:" { $code "(a*x - d) mod y == 0" } }
-{ $notes "If " { $snippet "d" } " is 1, then " { $snippet "a" } " is the inverse of " { $snippet "y" } " modulo " { $snippet "x" } "." } ;
+{ $notes "If " { $snippet "d" } " is 1, then " { $snippet "a" } " is the inverse of " { $snippet "x" } " modulo " { $snippet "y" } "." }
+{ $examples
+    { $example "USING: kernel math prettyprint ;" "54 26 gcd [ . ] bi@" "1\n2" }
+    { $example "USING: math prettyprint ;" "54 1 * 2 - 26 mod ." "0" }
+} ;
 
 HELP: lcm
 { $values { "a" integer } { "b" integer } { "c" integer } }