Skip to content

Commit

Permalink
doc(interface-types) Update the module documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hywan committed Apr 9, 2020
1 parent 4c2fb95 commit 3e9c3a1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
17 changes: 10 additions & 7 deletions lib/interface-types/src/interpreter/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,16 @@ pub(crate) type ExecutableInstruction<Instance, Export, LocalImport, Memory, Mem
///
/// ```rust,ignore
/// use std::{cell::Cell, collections::HashMap, convert::TryInto};
/// use wasmer_interface_types::interpreter::{
/// instructions::tests::{Export, Instance, LocalImport, Memory, MemoryView},
/// // ^^^^^^^^^^^^ This is private and for testing purposes only.
/// // It is basically a fake WebAssembly runtime.
/// stack::Stackable,
/// wasm::values::{InterfaceType, InterfaceValue},
/// Instruction, Interpreter,
/// use wasmer_interface_types::{
/// interpreter::{
/// instructions::tests::{Export, Instance, LocalImport, Memory, MemoryView},
/// // ^^^^^^^^^^^^ This is private and for testing purposes only.
/// // It is basically a fake WebAssembly runtime.
/// stack::Stackable,
/// Instruction, Interpreter,
/// },
/// types::InterfaceType,
/// values::InterfaceValue,
/// };
///
/// // 1. Creates an interpreter from a set of instructions. They will
Expand Down
4 changes: 2 additions & 2 deletions lib/interface-types/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
//! (which is not really abstract). This is the central
//! representation of the language.
//! 3. [Decoders](decoders): To read the [AST] from a particular data
//! representation; for instance, [`decoders::binary`] reads the
//! [AST] from a binary.
//! representation; for instance, [`decoders::binary::parse`] reads
//! the [AST] from a binary.
//! 4. [Encoders](encoders): To write the [AST](ast) into a particular
//! format; for instance, [`encoders::wat`] writes the [AST] into a
//! string representing WIT with its textual format.
Expand Down

0 comments on commit 3e9c3a1

Please sign in to comment.