Merge #3027

3027: Fixed residual package-doc issues r=ptitSeb a=ptitSeb

# Description
Fixed som residual doc issues that prevented `make package-docs` to build.

Co-authored-by: ptitSeb <[email protected]>

.github/workflows/test-sys.yaml

@@ -53,6 +53,7 @@ jobs:
             run_test: true
             run_test_capi: true
             run_integration_tests: true
+            run_build_docs: true
             use_sccache: true
           - build: macos-x64
             os: macos-11
@@ -63,12 +64,14 @@ jobs:
             use_sccache: true
             run_integration_tests: true
             run_ios_tests: true
+            run_build_docs: false
           - build: macos-arm64
             os: macos-11.0
             target: aarch64-apple-darwin
             use_sccache: true
             run_test: false
             run_test_capi: false
+            run_build_docs: false
           - build: windows-x64
             os: windows-2019
             #target: x86_64-pc-windows-msvc commented because of bug in rust setup action
@@ -78,13 +81,15 @@ jobs:
             use_sccache: true
             run_test: true
             run_test_capi: false # We can't run yet the capi tests on Windows
+            run_build_docs: false
           - build: linux-musl-x64
             target: x86_64-unknown-linux-musl
             os: ubuntu-latest
             container: alpine:latest
             run_test: true
             run_test_capi: false # It can't run the capi tests because of a cc linker issue (`wasm_engine_new` is redefined)
             run_integration_tests: false
+            run_build_docs: false
             use_sccache: false
     container: ${{ matrix.container }}
     env:
@@ -218,6 +223,10 @@ jobs:
         if: matrix.run_test_capi && matrix.os == 'windows-2019'
         run: |
           make test-capi
+      - name: Build Doc
+        if: matrix.run_build_docs
+        run: |
+          make package-docs
 
   audit:
     name: Audit

lib/api/src/lib.rs

@@ -196,10 +196,6 @@
 //! A Host function is any function implemented on the host, in this case in
 //! Rust.
 //!
-//! Host functions can optionally be created with an environment that
-//! implements [`WasmerEnv`]. This environment is useful for maintaining
-//! host state (for example the filesystem in WASI).
-//!
 //! 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`].

lib/api/src/sys/externals/global.rs

@@ -19,7 +19,7 @@ pub struct Global {
 }
 
 impl Global {
-    /// Create a new `Global` with the initial value [`Val`].
+    /// Create a new `Global` with the initial value [`Value`].
     ///
     /// # Example
     ///
@@ -36,7 +36,7 @@ impl Global {
         Self::from_value(ctx, val, Mutability::Const).unwrap()
     }
 
-    /// Create a mutable `Global` with the initial value [`Val`].
+    /// Create a mutable `Global` with the initial value [`Value`].
     ///
     /// # Example
     ///
@@ -53,7 +53,7 @@ impl Global {
         Self::from_value(ctx, val, Mutability::Var).unwrap()
     }
 
-    /// Create a `Global` with the initial value [`Val`] and the provided [`Mutability`].
+    /// Create a `Global` with the initial value [`Value`] and the provided [`Mutability`].
     fn from_value(
         ctx: &mut impl AsStoreMut,
         val: Value,
@@ -95,7 +95,7 @@ impl Global {
         *self.handle.get(ctx.as_store_ref().objects()).ty()
     }
 
-    /// Retrieves the current value [`Val`] that the Global has.
+    /// Retrieves the current value [`Value`] that the Global has.
     ///
     /// # Example
     ///
@@ -120,7 +120,7 @@ impl Global {
         }
     }
 
-    /// Sets a custom value [`Val`] to the runtime Global.
+    /// Sets a custom value [`Value`] to the runtime Global.
     ///
     /// # Example
     ///

lib/api/src/sys/function_env.rs

@@ -73,19 +73,19 @@ impl<T> Clone for FunctionEnv<T> {
     }
 }
 
-/// A temporary handle to a [`Context`].
+/// A temporary handle to a [`FunctionEnv`].
 pub struct FunctionEnvMut<'a, T: 'a> {
     pub(crate) store_mut: StoreMut<'a>,
     pub(crate) func_env: FunctionEnv<T>,
 }
 
 impl<T: Send + 'static> FunctionEnvMut<'_, T> {
-    /// Returns a reference to the host state in this context.
+    /// Returns a reference to the host state in this function environement.
     pub fn data(&self) -> &T {
         self.func_env.as_ref(&self.store_mut)
     }
 
-    /// Returns a mutable- reference to the host state in this context.
+    /// Returns a mutable- reference to the host state in this function environement.
     pub fn data_mut(&mut self) -> &mut T {
         self.func_env.as_mut(&mut self.store_mut)
     }

lib/api/src/sys/instance.rs

@@ -62,7 +62,7 @@ pub enum InstantiationError {
     #[error("missing required CPU features: {0:?}")]
     CpuFeature(String),
 
-    /// Import from a different [`Store`].
+    /// Import from a different Store.
     /// This error occurs when an import from a different store is used.
     #[error("cannot mix imports from different stores")]
     DifferentStores,

lib/api/src/sys/store.rs

@@ -145,7 +145,7 @@ impl fmt::Debug for Store {
     }
 }
 
-/// A temporary handle to a [`Context`].
+/// A temporary handle to a [`Store`].
 pub struct StoreRef<'a> {
     pub(crate) inner: &'a StoreInner,
 }
@@ -182,7 +182,7 @@ impl<'a> StoreRef<'a> {
     }
 }
 
-/// A temporary handle to a [`Context`].
+/// A temporary handle to a [`Store`].
 pub struct StoreMut<'a> {
     pub(crate) inner: &'a mut StoreInner,
 }