Add information about the fast_test feature to the docstring of is_prime

JSorngard · Jan 2, 2025 · 68598a4 · 68598a4
1 parent 384264c
commit 68598a4
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/check.rs b/src/check.rs
@@ -8,6 +8,8 @@ use crate::integer_math::{mod_mul, mod_pow};
 /// Does trial division with a small wheel up to `log2(n)` and then uses a
 /// deterministic Miller-Rabin primality test.
 ///
+/// If the `fast_test` feature is enabled this function calls the [`machine_prime::is_prime`] function with the `lucas` feature instead.
+///
 /// # Example
 ///
 /// Basic usage: