Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc build #3668

Merged
merged 1 commit into from
Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/api/src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ impl<T: Into<engine_imp::Engine>> From<T> for Engine {
}

/// A temporary handle to an [`Engine`]
/// EngineRef can be used to build a [`Module`][wasmer::Module]
/// EngineRef can be used to build a [`Module`][super::Module]
/// It can be created directly with an [`Engine`]
/// Or from anything implementing [`AsEngineRef`]
/// like from [`Store`][wasmer::Store] typicaly.
/// like from [`Store`][super::Store] typicaly.
pub struct EngineRef<'a> {
/// The inner engine
pub(crate) inner: &'a Engine,
Expand Down
2 changes: 1 addition & 1 deletion lib/api/src/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pub enum InstantiationError {
#[cfg_attr(feature = "std", error("missing required CPU features: {0:?}"))]
CpuFeature(String),

/// Import from a different [`Store`].
/// Import from a different [`Store`][super::Store].
/// This error occurs when an import from a different store is used.
#[cfg_attr(feature = "std", error("cannot mix imports from different stores"))]
DifferentStores,
Expand Down
6 changes: 3 additions & 3 deletions lib/api/src/instance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ pub struct Instance {

impl Instance {
/// Creates a new `Instance` from a WebAssembly [`Module`] and a
/// set of imports using [`Imports`] or the [`imports`] macro helper.
/// set of imports using [`Imports`] or the [`imports!`] macro helper.
///
/// [`imports`]: crate::imports
/// [`Imports`]: crate::Imports
/// [`imports!`]: crate::imports!
/// [`Imports!`]: crate::Imports!
///
/// ```
/// # use wasmer::{imports, Store, Module, Global, Value, Instance};
Expand Down
4 changes: 2 additions & 2 deletions lib/api/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
//! module.
//!
//! To import an extern, simply give it a namespace and a name with the
//! [`imports`] macro:
//! [`imports!`] macro:
//!
//! ```
//! # use wasmer::{imports, Function, FunctionEnv, FunctionEnvMut, Memory, MemoryType, Store, Imports};
Expand Down Expand Up @@ -192,7 +192,7 @@
//!
//! Thus WebAssembly modules by themselves cannot do anything but computation
//! on the core types in [`Value`]. In order to make them more useful we
//! give them access to the outside world with [`imports`].
//! give them access to the outside world with [`imports!`].
//!
//! If you're looking for a sandboxed, POSIX-like environment to execute Wasm
//! in, check out the [`wasmer-wasi`] crate for our implementation of WASI,
Expand Down
2 changes: 1 addition & 1 deletion lib/api/src/mem_access.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use std::string::FromUtf8Error;
use thiserror::Error;
use wasmer_types::ValueType;

/// Error for invalid [`Memory`] access.
/// Error for invalid [`Memory`][super::Memory] access.
#[derive(Clone, Copy, Debug, Error)]
#[non_exhaustive]
pub enum MemoryAccessError {
Expand Down
4 changes: 2 additions & 2 deletions lib/api/src/sys/externals/function.rs
Original file line number Diff line number Diff line change
Expand Up @@ -449,8 +449,8 @@ where
}

/// Represents a low-level Wasm static host function. See
/// [`super::Function::new_typed`] and
/// [`super::Function::new_typed_with_env`] to learn more.
/// [`crate::Function::new_typed`] and
/// [`crate::Function::new_typed_with_env`] to learn more.
pub(crate) struct StaticFunction<F, T> {
pub(crate) raw_store: *mut u8,
pub(crate) env: FunctionEnv<T>,
Expand Down