This is an automated email from the ASF dual-hosted git repository.
liurenjie1024 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 1aa05e0 docs(writer/docker): fix small typos and wording (#389)
1aa05e0 is described below
commit 1aa05e0e12f7152bb473101cfb06feeb76b7c66f
Author: Jack <[email protected]>
AuthorDate: Sun Jun 2 03:43:50 2024 +0100
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 216e94f..5f3ae55 100644
--- a/crates/iceberg/src/writer/mod.rs
+++ b/crates/iceberg/src/writer/mod.rs
@@ -75,7 +75,7 @@ pub trait IcebergWriter<I = DefaultInput, O = DefaultOutput>:
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<O>;
}
diff --git a/crates/test_utils/src/docker.rs b/crates/test_utils/src/docker.rs
index 6c5fbef..df3c754 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,
