From ceeeef354e0c3b7715aeb90285df55d9abfa6071 Mon Sep 17 00:00:00 2001 From: Elias Dalbeck Date: Wed, 9 Oct 2024 01:44:51 +0200 Subject: [PATCH] documentation, cleanup --- src/core.rs | 1 + src/core/wordlist.rs | 2 ++ 2 files changed, 3 insertions(+) diff --git a/src/core.rs b/src/core.rs index 04b1828b..3696c495 100644 --- a/src/core.rs +++ b/src/core.rs @@ -5,6 +5,7 @@ pub mod rendezvous; mod server_messages; #[cfg(test)] mod test; +#[doc(hidden)] pub mod wordlist; use serde_derive::{Deserialize, Serialize}; diff --git a/src/core/wordlist.rs b/src/core/wordlist.rs index 7f9c125f..4058c4a5 100644 --- a/src/core/wordlist.rs +++ b/src/core/wordlist.rs @@ -1,3 +1,4 @@ +///! Wordlist generation and wormhole code utilities use rand::{rngs::OsRng, seq::SliceRandom}; use serde_json::{self, Value}; use std::fmt; @@ -20,6 +21,7 @@ impl fmt::Debug for Wordlist { impl Wordlist { #[cfg(test)] + #[doc(hidden)] pub fn new(num_words: usize, words: Vec>) -> Wordlist { Wordlist { num_words, words } }