From 8e0368198ec70d8b252438e5c4e70b02c403debd Mon Sep 17 00:00:00 2001 From: Jack Dockerty Date: Sat, 1 Jun 2024 17:48:49 +0100 Subject: [PATCH 1/2] docs: fixup docker compose test_utils --- crates/test_utils/src/docker.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/test_utils/src/docker.rs b/crates/test_utils/src/docker.rs index 6c5fbef1eb..df3c754392 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, From 11b5bdbd4520344cad625e9f4637b6883d9aff32 Mon Sep 17 00:00:00 2001 From: Jack Dockerty Date: Sat, 1 Jun 2024 17:49:45 +0100 Subject: [PATCH 2/2] docs: iceberg writer close fn --- crates/iceberg/src/writer/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/iceberg/src/writer/mod.rs b/crates/iceberg/src/writer/mod.rs index 216e94f9e3..5f3ae5581c 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; }