diff --git a/src/executors/bash_runner.rs b/src/executors/bash_runner.rs index b0e6619..5b49713 100644 --- a/src/executors/bash_runner.rs +++ b/src/executors/bash_runner.rs @@ -51,7 +51,8 @@ pub const BASH_EXCLUDED_VARIABLES: &[&str] = &[ const BASH_TEMPLATE: &str = include_str!("bash_runner.template"); -/// A [`Runner`], that is intended to run a series of contextual related [`Execution`]s, which +/// A [`Runner`], that is intended to run a series of contextual related +/// [`crate::executors::execution::Execution`]s, which /// that ought to share the same environmental context (environment variables, shell /// variables, shopt, set, functions and aliases). /// @@ -67,7 +68,7 @@ const BASH_TEMPLATE: &str = include_str!("bash_runner.template"); /// This Runner is not concurrency-safe (the shared state directory with the `state` file mandates /// sequential, isolated execution). /// -/// Underlying the [`ThreadedRunner`] is used, so timeout constraints are fully supported. +/// Underneath the [`SubprocessRunner`] is used, so timeout constraints are fully supported. #[derive(Clone)] pub struct BashRunner { pub shell: PathBuf, diff --git a/src/executors/mod.rs b/src/executors/mod.rs index 822cdb8..aec4773 100644 --- a/src/executors/mod.rs +++ b/src/executors/mod.rs @@ -14,12 +14,8 @@ //! described in the [`crate::executors::executor::Executor`] trait. //! //! Currently there are two implementations available: -//! - [`crate::executors::sequential_shell`], which runs executions from within -//! a file sequentially, allowing for shared state (environment variables, -//! aliases) to be "passed down" -//! - [`crate::executors::parallel_shell`], which runs executions from within -//! a file in parallel, returning results quickly, but not supporting shared -//! state in between +//! - [`crate::executors::bash_script_executor::BashScriptExecutor`] +//! - [`crate::executors::stateful_executor::StatefulExecutor`] use std::path::Path; diff --git a/src/parsers/markdown.rs b/src/parsers/markdown.rs index 6127529..56514f8 100644 --- a/src/parsers/markdown.rs +++ b/src/parsers/markdown.rs @@ -161,11 +161,13 @@ pub(crate) enum MarkdownToken { /// The parsed contents of a code block within backticks, representing a Scrut test: /// + /// ````markdown /// ```scrut { ... config ..} /// # comment /// $ shell expression /// output expectations /// ``` + /// ```` TestCodeBlock { /// The used language token of the test (i.e. `scrut`) language: String, diff --git a/src/renderers/diff.rs b/src/renderers/diff.rs index 5f888f0..44a8801 100644 --- a/src/renderers/diff.rs +++ b/src/renderers/diff.rs @@ -21,7 +21,7 @@ use crate::outcome::Outcome; use crate::parsers::parser::ParserType; /// Renderer that uses the traditional Diff render format -/// See: https://en.wikipedia.org/wiki/Diff +/// See: pub struct DiffRenderer {} impl DiffRenderer { diff --git a/src/renderers/mod.rs b/src/renderers/mod.rs index 438b3a8..cdfe80c 100644 --- a/src/renderers/mod.rs +++ b/src/renderers/mod.rs @@ -5,7 +5,7 @@ * LICENSE file in the root directory of this source tree. */ -//! This module is concerned with rendering the [`outcome::Outcome`] of test +//! This module is concerned with rendering the [`crate::outcome::Outcome`] of test //! executions. pub mod diff;