Skip to content

Commit 572399d

Browse files
bors[bot]Mark McCaskey
and
Mark McCaskey
authored
Merge #1089
1089: Add misc doc link fixes and update old comment r=MarkMcCaskey a=MarkMcCaskey I spent way too long trying to make things work, `#[doc(no_inline)]`, adding doc comments on top of things with doc comments, and linking in the context of inlining are way harder than they seem like they should be 🙀 Co-authored-by: Mark McCaskey <[email protected]>
2 parents 823c699 + ad8945a commit 572399d

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

lib/runtime-core/src/lib.rs

-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,6 @@ pub mod prelude {
105105
/// WebAssembly binary code. This function is useful if it
106106
/// is necessary to a compile a module before it can be instantiated
107107
/// and must be used if you wish to use a different backend from the default.
108-
///
109-
/// [`Module`]: struct.Module.html
110108
pub fn compile_with(
111109
wasm: &[u8],
112110
compiler: &dyn backend::Compiler,

lib/runtime-core/src/module.rs

+2-4
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,9 @@ impl ModuleInfo {
101101

102102
/// A compiled WebAssembly module.
103103
///
104-
/// `Module` is returned by the [`compile`] and
105-
/// [`compile_with`] functions.
104+
/// `Module` is returned by the [`compile_with`][] function.
106105
///
107-
/// [`compile`]: fn.compile.html
108-
/// [`compile_with`]: fn.compile_with.html
106+
/// [`compile_with`]: crate::compile_with
109107
pub struct Module {
110108
inner: Arc<ModuleInner>,
111109
}

lib/runtime/src/lib.rs

+7-3
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,17 @@
7979
//! # Additional Notes:
8080
//!
8181
//! The `wasmer-runtime` is build to support compiler multiple backends.
82-
//! Currently, we support the [Cranelift] compiler with the [`wasmer-clif-backend`] crate.
82+
//! Currently, we support the Singlepass, [Cranelift], and LLVM compilers
83+
//! with the [`wasmer-singlepass-backend`], [`wasmer-clif-backend`], and
84+
//! wasmer-llvm-backend crates, respectively.
8385
//!
84-
//! You can specify the compiler you wish to use with the [`compile_with`] function.
86+
//! You can specify the compiler you wish to use with the [`compile_with`]
87+
//! function or use the default with the [`compile`] function.
8588
//!
8689
//! [Cranelift]: https://github.com/CraneStation/cranelift
90+
//! [LLVM]: https://llvm.org
91+
//! [`wasmer-singlepass-backend`]: https://crates.io/crates/wasmer-singlepass-backend
8792
//! [`wasmer-clif-backend`]: https://crates.io/crates/wasmer-clif-backend
88-
//! [`compile_with`]: fn.compile_with.html
8993
9094
pub use wasmer_runtime_core::backend::{Backend, Features};
9195
pub use wasmer_runtime_core::codegen::{MiddlewareChain, StreamingCompiler};

lib/wasi/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ pub fn generate_import_object(
8181
}
8282

8383
/// Create an [`ImportObject`] with an existing [`WasiState`]. [`WasiState`]
84-
/// can be constructed from a [`WasiStateBuilder`].
84+
/// can be constructed from a [`WasiStateBuilder`](state::WasiStateBuilder).
8585
pub fn generate_import_object_from_state(
8686
wasi_state: WasiState,
8787
version: WasiVersion,

0 commit comments

Comments
 (0)