From 1aa05e0e12f7152bb473101cfb06feeb76b7c66f Mon Sep 17 00:00:00 2001 From: Jack <56563911+jdockerty@users.noreply.github.com> Date: Sun, 2 Jun 2024 03:43:50 +0100 Subject: [PATCH] docs(writer/docker): fix small typos and wording (#389) * docs: fixup docker compose test_utils * docs: iceberg writer close fn --- crates/iceberg/src/writer/mod.rs | 2 +- crates/test_utils/src/docker.rs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/iceberg/src/writer/mod.rs b/crates/iceberg/src/writer/mod.rs index 216e94f9e..5f3ae5581 100644 --- a/crates/iceberg/src/writer/mod.rs +++ b/crates/iceberg/src/writer/mod.rs @@ -75,7 +75,7 @@ pub trait IcebergWriter: Send + 'static { /// Close the writer and return the written data files. /// If close failed, the data written before maybe be lost. User may need to recreate the writer and rewrite the data again. /// # NOTE - /// After close, no matter successfully or fail,the writer should never be used again, otherwise the writer will panic. + /// After close, regardless of success or failure, the writer should never be used again, otherwise the writer will panic. async fn close(&mut self) -> Result; } diff --git a/crates/test_utils/src/docker.rs b/crates/test_utils/src/docker.rs index 6c5fbef1e..df3c75439 100644 --- a/crates/test_utils/src/docker.rs +++ b/crates/test_utils/src/docker.rs @@ -18,9 +18,9 @@ use crate::cmd::{get_cmd_output, run_command}; use std::process::Command; -/// A utility to manage lifecycle of docker compose. +/// A utility to manage the lifecycle of `docker compose`. /// -/// It's will start docker compose when calling `run` method, and will be stopped when dropped. +/// It will start `docker compose` when calling the `run` method and will be stopped via [`Drop`]. #[derive(Debug)] pub struct DockerCompose { project_name: String,