Skip to content

Commit

Permalink
removed temporary documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kernelPanic0x committed Sep 23, 2024
1 parent dedf39a commit a5adcd9
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions src/core/wordlist.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,35 +96,6 @@ fn load_pgpwords() -> Vec<Vec<String>> {
vec![even_words, odd_words]
}

/// Creates a default `Wordlist` with a specified number of words.
///
/// This function generates a `Wordlist` using the PGP word list, which is a standardized
/// list of words often used for secure and human-readable encoding.
///
/// # Arguments
///
/// * `num_words` - The number of words that should be in a complete wormhole code.
///
/// # Returns
///
/// Returns a `Wordlist` instance initialized with the PGP word list and the specified
/// number of words.
///
/// # Examples
///
/// ```
/// use your_crate_name::default_wordlist;
///
/// let wordlist = default_wordlist(3);
/// assert_eq!(wordlist.num_words, 3);
/// assert_eq!(wordlist.words.len(), 2); // PGP word list has two lists (even and odd)
/// ```
///
/// # Note
///
/// The PGP word list consists of two lists of 256 words each: one for even positions
/// and one for odd positions in the code. This function uses these lists regardless
/// of the `num_words` specified.
pub fn default_wordlist(num_words: usize) -> Wordlist {
Wordlist {
num_words,
Expand Down

0 comments on commit a5adcd9

Please sign in to comment.