Skip to content

Commit

Permalink
Document that the feature fast_test affects is_prime also in its …
Browse files Browse the repository at this point in the history
…docs (#88)

* Document that the feature affects is_prime also in its docs

* cargo fmt
  • Loading branch information
JSorngard authored Nov 29, 2024
1 parent 6fc4e9f commit d6d7ad7
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/check.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,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 instead calls [`machine_prime::is_prime`] with the `small` feature.
///
/// # Example
///
/// Basic usage:
Expand Down

0 comments on commit d6d7ad7

Please sign in to comment.