From c66a3c23f3f27c68cc1eeb10d653be00db9b4612 Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Thu, 3 Jan 2019 11:29:01 -0800 Subject: [PATCH] Tidy up some documentation comments. --- README.md | 2 +- lib/environ/src/compilation.rs | 4 ++-- lib/environ/src/func_environ.rs | 2 +- lib/runtime/src/instance.rs | 2 +- lib/wast/src/wast.rs | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9b3de14970..fe1ef7e4a4 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ utility or as a library embedded in a larger application. [![Gitter chat](https://badges.gitter.im/CraneStation/CraneStation.svg)](https://gitter.im/CraneStation/Lobby) ![Minimum rustc 1.30](https://img.shields.io/badge/rustc-1.30+-green.svg) -*Wasmtime is complete enough to pass the WebAssemlbly spec testsuite.* Support for +*Wasmtime is complete enough to pass the WebAssembly spec testsuite.* Support for system APIs is coming soon! One goal for this project is to implement [CloudABI](https://cloudabi.org/) using diff --git a/lib/environ/src/compilation.rs b/lib/environ/src/compilation.rs index 2ae7fb62c2..ca0b845222 100644 --- a/lib/environ/src/compilation.rs +++ b/lib/environ/src/compilation.rs @@ -8,7 +8,7 @@ use cranelift_entity::PrimaryMap; use cranelift_wasm::{DefinedFuncIndex, FuncIndex, WasmError}; use std::vec::Vec; -/// The result of compiling a WebAssemby module's functions. +/// The result of compiling a WebAssembly module's functions. #[derive(Debug)] pub struct Compilation { /// Compiled machine code for the function bodies. @@ -35,7 +35,7 @@ pub struct Relocation { pub addend: binemit::Addend, } -/// Destination function. Can be either user function or some special one, like grow_memory. +/// Destination function. Can be either user function or some special one, like `memory.grow`. #[derive(Debug, Copy, Clone)] pub enum RelocationTarget { /// The user function index. diff --git a/lib/environ/src/func_environ.rs b/lib/environ/src/func_environ.rs index cfab4b9e2f..f028f89667 100644 --- a/lib/environ/src/func_environ.rs +++ b/lib/environ/src/func_environ.rs @@ -48,7 +48,7 @@ pub fn get_imported_memory32_size_name() -> ir::ExternalName { ir::ExternalName::user(1, 3) } -/// The FuncEnvironment implementation for use by the `ModuleEnvironment`. +/// The `FuncEnvironment` implementation for use by the `ModuleEnvironment`. pub struct FuncEnvironment<'module_environment> { /// Target-specified configuration. target_config: TargetFrontendConfig, diff --git a/lib/runtime/src/instance.rs b/lib/runtime/src/instance.rs index 270019f751..e877200c20 100644 --- a/lib/runtime/src/instance.rs +++ b/lib/runtime/src/instance.rs @@ -422,7 +422,7 @@ impl Drop for MmapField { } } -/// An Instance of a WebAssemby module. +/// An Instance of a WebAssembly module. /// /// Note that compiled wasm code passes around raw pointers to `Instance`, so /// this shouldn't be moved. diff --git a/lib/wast/src/wast.rs b/lib/wast/src/wast.rs index aeab7bfeb6..b08dddc341 100644 --- a/lib/wast/src/wast.rs +++ b/lib/wast/src/wast.rs @@ -9,7 +9,7 @@ use wasmtime_jit::{ Namespace, RuntimeValue, SetupError, }; -/// Translate from a script::Value to a RuntimeValue. +/// Translate from a `script::Value` to a `RuntimeValue`. fn runtime_value(v: Value) -> RuntimeValue { match v { Value::I32(x) => RuntimeValue::I32(x),