From f02129f46b6ec92016dafbfff30b4400e02daf35 Mon Sep 17 00:00:00 2001 From: Thomas Wessel Date: Fri, 3 Oct 2025 18:36:44 +0200 Subject: [PATCH 1/4] Fixed docstring (caused warning). src/parsers/markdown.rs:162, added outer code fence around sample code fence --- src/parsers/markdown.rs | 2 ++ 1 file changed, 2 insertions(+) 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, From 9bbab7016e3ac6d7d3a915915b2fda82f8e3b3bf Mon Sep 17 00:00:00 2001 From: Thomas Wessel Date: Fri, 3 Oct 2025 19:23:02 +0200 Subject: [PATCH 2/4] Fixed url in docstring --- src/renderers/diff.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 { From 18cdb8d0a9dc8830e7eb6ed55b0cc1b64b014c4f Mon Sep 17 00:00:00 2001 From: Thomas Wessel Date: Fri, 3 Oct 2025 22:42:07 +0200 Subject: [PATCH 3/4] Updated outdated docstring in src/executors/mod.rs, referred to non-existant modules sequential_shell and parallel_shell --- src/executors/mod.rs | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) 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; From 48c052c31351a86434e51c892c661df774ba9c36 Mon Sep 17 00:00:00 2001 From: Thomas Wessel Date: Fri, 3 Oct 2025 23:24:17 +0200 Subject: [PATCH 4/4] Fixed three unresolved links in docstrings (renderers/mod.rs and bash_runner.rs) --- src/executors/bash_runner.rs | 5 +++-- src/renderers/mod.rs | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) 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/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;