Add #![warn(missing_docs)] in lib.rs

input-output-hk · Jan 17, 2024 · 14df6c8 · 14df6c8
1 parent 0541ace
commit 14df6c8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/mithril-client-wasm/src/client_wasm.rs b/mithril-client-wasm/src/client_wasm.rs
@@ -50,6 +50,7 @@ impl From<MithrilEvent> for MithrilEventWasm {
     }
 }
 
+/// Structure that wraps a [Client] and enables its functions to be used in WASM
 #[wasm_bindgen]
 pub struct MithrilClient {
     client: Client,

diff --git a/mithril-client-wasm/src/lib.rs b/mithril-client-wasm/src/lib.rs
@@ -1,3 +1,5 @@
+#![warn(missing_docs)]
+//! Implementation of the 'mithril-client' library in WASM
 mod client_wasm;
 
 pub use client_wasm::MithrilClient;