Skip to content

Commit 24bb656

Browse files
committed
Add short descriptions of the modules
1 parent 860f454 commit 24bb656

File tree

4 files changed

+9
-0
lines changed

4 files changed

+9
-0
lines changed

src/cache.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
//! This module contains an implementation of a type that functions as a cache of prime numbers
2+
//! for related computations.
3+
14
use crate::{primes, Underlying};
25

36
// region: Primes<N>

src/generate.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! This module contains implementations of prime generation functions.
2+
13
use core::fmt;
24

35
use crate::{sieve, sieve::sieve_segment, Underlying};

src/search.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! This module contains implementations of functions that search for primes that neighbour a given number.
2+
13
use crate::is_prime;
24

35
/// Returns the largest prime smaller than `n` if there is one.

src/sieve.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! This module contains implementations of prime sieves.
2+
13
use core::fmt;
24

35
use crate::isqrt;

0 commit comments

Comments
 (0)