Refine documentation and comments.

This commit is contained in:
Stephen Chung
2021-01-11 23:09:33 +08:00
parent 5b9a18f5b8
commit 8c47d61456
10 changed files with 65 additions and 54 deletions

View File

@@ -1,7 +1,7 @@
use crate::stdlib::{boxed::Box, ops::AddAssign, vec::Vec};
use crate::{Engine, EvalAltResult, Module, ModuleResolver, Position, Shared};
/// [Module] resolution service that holds a collection of [module][Module] resolves,
/// [Module] resolution service that holds a collection of module resolvers,
/// to be searched in sequential order.
///
/// # Example

View File

@@ -29,7 +29,7 @@ pub trait ModuleResolver: SendSync {
pos: Position,
) -> Result<Shared<Module>, Box<EvalAltResult>>;
/// Resolve a module into an `AST` based on a path string.
/// Resolve an `AST` based on a path string.
///
/// Returns [`None`] (default) if such resolution is not supported
/// (e.g. if the module is Rust-based).

View File

@@ -1,7 +1,7 @@
use crate::stdlib::{boxed::Box, collections::HashMap, ops::AddAssign, string::String};
use crate::{Engine, EvalAltResult, Module, ModuleResolver, Position, Shared};
/// [Module] resolution service that serves [modules][Module] added into it.
/// A static [module][Module] resolution service that serves [modules][Module] added into it.
///
/// # Example
///