Catch cargo doc warnings in CI (#1987)

* Catch `cargo doc` warnings in CI * Fix remaining warnings from `cargo doc --all`
bytecodealliance · Jan 27, 2025 · 866672f · 866672f
1 parent e7ca2cf
commit 866672f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -277,7 +277,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - run: cargo doc --all
+      - run: RUSTDOCFLAGS="-Dwarnings" cargo doc --all
 
   clippy:
     runs-on: ubuntu-latest

diff --git a/crates/wasm-wave/src/wasm/ty.rs b/crates/wasm-wave/src/wasm/ty.rs
@@ -62,7 +62,7 @@ impl std::fmt::Display for WasmTypeKind {
 
 /// The WasmType trait may be implemented to represent types to be
 /// (de)serialized with WAVE, notably [`value::Type`](crate::value::Type).
-/// The [`wasmtime`] crate provides an impl for [`wasmtime::component::Type`].
+/// The `wasmtime` crate provides an impl for `wasmtime::component::Type`.
 ///
 /// The `Self`-returning methods should be called only for corresponding
 /// [`WasmTypeKind`]s.

diff --git a/crates/wasm-wave/src/wasm/val.rs b/crates/wasm-wave/src/wasm/val.rs
@@ -4,7 +4,7 @@ use crate::wasm::{WasmType, WasmTypeKind, WasmValueError};
 
 /// The WasmValue trait may be implemented to represent values to be
 /// (de)serialized with WAVE, notably [`value::Value`](crate::value::Value).
-/// The `wasmtime` crate provides an impl for [`wasmtime::component::Val`].
+/// The `wasmtime` crate provides an impl for `wasmtime::component::Val`.
 ///
 /// The `make_*` and `unwrap_*` methods should be called only for corresponding
 /// [`WasmTypeKind`](crate::wasm::WasmTypeKind)s.