docs: refactor and update docs of mitex-{spec-gen,wasm}

Cargo.toml

@@ -63,7 +63,6 @@ missing_docs = "warn"
 
 [workspace.lints.clippy]
 uninlined_format_args = "warn"
-missing_errors_doc = "warn"
 missing_panics_doc = "warn"
 missing_safety_doc = "warn"
 undocumented_unsafe_blocks = "warn"

crates/mitex-spec-gen/src/lib.rs

@@ -1,8 +1,13 @@
-//! Generate Default Command Specification for embedded LaTeX packages.
+//! Provides embedded command specifications for MiTeX.
 
 use mitex_spec::CommandSpec;
 
-/// Default Command Specification.
+/// The default command specification.
+///
+/// See [Reproducing Default Command Specification][repro-default] for more
+/// information.
+///
+/// [repro-default]: https://github.com/mitex-rs/artifacts/blob/main/README.md#default-command-specification-since-v011
 pub static DEFAULT_SPEC: once_cell::sync::Lazy<CommandSpec> = once_cell::sync::Lazy::new(|| {
     CommandSpec::from_bytes(include_bytes!(
         "../../../target/mitex-artifacts/spec/default.rkyv"

crates/mitex-wasm/src/lib.rs

@@ -2,8 +2,8 @@
 //!
 //! # Usage
 //!
-//! For example, if you want to call [`convert_math`] function in Typst, you can
-//! write the following code in your Typst file:
+//! For example, you can call [`convert_math`] function in Typst by loading the
+//! plugin:
 //!
 //! ```typ
 //! #let mitex-wasm = plugin("./mitex.wasm")
@@ -36,36 +36,25 @@ mod impls {
         Result::Ok(res.to_bytes())
     }
 
-    /// Converts a LaTeX math equation into a plain text
-    ///
-    /// # Errors
-    /// Returns an error if the input is not a valid math equation
+    /// Extracts the command specification from its binary (rkyv)
+    /// representation.
+    fn extract_spec(spec: &[u8]) -> Option<mitex_spec::CommandSpec> {
+        (!spec.is_empty()).then(|| mitex_spec::CommandSpec::from_bytes(spec))
+    }
+
+    /// Converts a LaTeX math equation into a plain text. You can pass an binary
+    /// (rkyv) command specification by `spec` at the same time to customize
+    /// parsing.
     #[cfg_attr(feature = "web", wasm_bindgen)]
     pub fn convert_math(input: &str, spec: &[u8]) -> Result<String, String> {
-        let spec = if spec.is_empty() {
-            None
-        } else {
-            let spec = mitex_spec::CommandSpec::from_bytes(spec);
-            Some(spec)
-        };
-        let res = mitex::convert_math(input, spec)?;
-        Result::Ok(res)
+        mitex::convert_math(input, extract_spec(spec))
     }
 
-    /// Converts a LaTeX code into a plain text
-    ///
-    /// # Errors
-    /// Returns an error if the input is not a valid LaTeX code
+    /// Converts a LaTeX code into a plain text. You can pass an binary (rkyv)
+    /// command specification by `spec` at the same time to customize parsing.
     #[cfg_attr(feature = "web", wasm_bindgen)]
     pub fn convert_text(input: &str, spec: &[u8]) -> Result<String, String> {
-        let spec = if spec.is_empty() {
-            None
-        } else {
-            let spec = mitex_spec::CommandSpec::from_bytes(spec);
-            Some(spec)
-        };
-        let res = mitex::convert_text(input, spec)?;
-        Result::Ok(res)
+        mitex::convert_text(input, extract_spec(spec))
     }
 }