documentation, cleanup

magic-wormhole · Oct 8, 2024 · ceeeef3 · ceeeef3
1 parent f341998
commit ceeeef3
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git 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
@@ -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<Vec<String>>) -> Wordlist {
         Wordlist { num_words, words }
     }