From 57756147075e75762bf7af637f84879108d6a47c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Cabrera?= Date: Tue, 13 Aug 2024 15:45:24 -0400 Subject: [PATCH] Improve some documentation --- crates/cli/src/codegen/builder.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/crates/cli/src/codegen/builder.rs b/crates/cli/src/codegen/builder.rs index de61af4d..0b03a9aa 100644 --- a/crates/cli/src/codegen/builder.rs +++ b/crates/cli/src/codegen/builder.rs @@ -32,7 +32,7 @@ impl WitOptions { self.path.is_some() && self.world.is_some() } - /// Unwraps a refernce to the .wit file. + /// Unwraps a refernce to the .wit file path. pub fn unwrap_path(&self) -> &PathBuf { self.path.as_ref().unwrap() } @@ -66,12 +66,13 @@ impl CodeGenBuilder { self } - /// Set the wit options + /// Set the wit options. pub fn wit_opts(&mut self, opts: WitOptions) -> &mut Self { self.wit_opts = opts; self } + /// Whether to compress the JS source. pub fn source_compression(&mut self, compress: bool) -> &mut Self { self.source_compression = compress; self