Document floretta::Error

samestep · Nov 20, 2024 · c5776aa · c5776aa
1 parent f73a4a8
commit c5776aa
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/floretta/src/lib.rs b/crates/floretta/src/lib.rs
@@ -43,11 +43,14 @@ use wasmparser::{
     Payload, Validator, ValidatorResources, WasmFeatures,
 };
 
+/// An error that occurred during code transformation.
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
+    /// The error occurred while parsing or validating the input Wasm.
     #[error("Wasm parsing or validation error: {0}")]
     Parse(#[from] BinaryReaderError),
 
+    /// The error occurred while reencoding part of the input Wasm into the output Wasm.
     #[error("Wasm reencoding error: {0}")]
     Reencode(#[from] reencode::Error),
 }