From 2e39c52353dab119d3208f4c8a29218c1f280fb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20Avic=20Simmons?= Date: Fri, 23 Oct 2026 01:51:48 -0400 Subject: [PATCH] docs: fix typos in error messages, doc comments and examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - runner/error.rs: "expected to be ≥ that {minimal}" -> "expected to be ≥ {minimal}" - runner/error.rs: "Fail run compose" -> "Fail to run compose" (matches the variant's doc comment) - container/wait_condition.rs: "healt check" -> "health check" (2x) - compose/temp_dir.rs, compose/images/doc.md, examples/compose_custom_images.rs: "componse-nginx" -> "compose-nginx" - compose/images/doc.md: "a temporary directory what will be removed" -> "that will be removed" Signed-off-by: Léon Avic Simmons --- rustainers/examples/compose_custom_images.rs | 2 +- rustainers/src/compose/images/doc.md | 4 ++-- rustainers/src/compose/temp_dir.rs | 2 +- rustainers/src/container/wait_condition.rs | 4 ++-- rustainers/src/runner/error.rs | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/rustainers/examples/compose_custom_images.rs b/rustainers/examples/compose_custom_images.rs index d8622fc..5f61889 100644 --- a/rustainers/examples/compose_custom_images.rs +++ b/rustainers/examples/compose_custom_images.rs @@ -40,7 +40,7 @@ struct ComposeNginx { impl ComposeNginx { async fn new() -> Self { let temp_dir = TemporaryDirectory::with_files( - "componse-nginx", + "compose-nginx", [TemporaryFile::builder() .with_path("docker-compose.yaml") .with_content( diff --git a/rustainers/src/compose/images/doc.md b/rustainers/src/compose/images/doc.md index 4604b01..0b94249 100644 --- a/rustainers/src/compose/images/doc.md +++ b/rustainers/src/compose/images/doc.md @@ -55,9 +55,9 @@ struct ComposeNginx { impl ComposeNginx { async fn new() -> Self { - // Create a temporary directory what will be removed when the containers stop + // Create a temporary directory that will be removed when the containers stop let temp_dir = TemporaryDirectory::with_files( - "componse-nginx", // a name prefix + "compose-nginx", // a name prefix [ // One docker-compose.yaml file TemporaryFile::builder() diff --git a/rustainers/src/compose/temp_dir.rs b/rustainers/src/compose/temp_dir.rs index 9640ed1..cb7e6ea 100644 --- a/rustainers/src/compose/temp_dir.rs +++ b/rustainers/src/compose/temp_dir.rs @@ -47,7 +47,7 @@ pub struct TemporaryFile { /// # use rustainers::compose::{TemporaryDirectory, TemporaryFile}; /// # async fn build() { /// let temp_dir = TemporaryDirectory::with_files( -/// "componse-nginx", +/// "compose-nginx", /// [TemporaryFile::builder() /// .with_path("docker-compose.yaml") /// .with_content(r#"..."#) diff --git a/rustainers/src/container/wait_condition.rs b/rustainers/src/container/wait_condition.rs index cc97af7..48878fb 100644 --- a/rustainers/src/container/wait_condition.rs +++ b/rustainers/src/container/wait_condition.rs @@ -63,13 +63,13 @@ impl WaitStrategy { Self::None } - /// Wait with image healt check + /// Wait with image health check #[must_use] pub fn health_check() -> Self { Self::HealthCheck } - /// Wait with image healt check + /// Wait with image health check #[must_use] pub fn custom_health_check(health_check: HealthCheck) -> Self { Self::CustomHealthCheck(health_check) diff --git a/rustainers/src/runner/error.rs b/rustainers/src/runner/error.rs index 36c4002..edf7336 100644 --- a/rustainers/src/runner/error.rs +++ b/rustainers/src/runner/error.rs @@ -16,7 +16,7 @@ pub enum RunnerError { CommandNotAvailable(String), /// Unsupported version - #[error("{command} version {current} expected to be ≥ that {minimal}")] + #[error("{command} version {current} expected to be ≥ {minimal}")] UnsupportedVersion { /// The command command: String, @@ -154,7 +154,7 @@ pub enum RunnerError { }, /// Fail to run compose - #[error("Fail run compose in {path:?} because {source}\nrunner: {runner}")] + #[error("Fail to run compose in {path:?} because {source}\nrunner: {runner}")] ComposeError { /// The runner runner: Runner,