Skip to content

Commit 1aa05e0

Browse files
authored
docs(writer/docker): fix small typos and wording (#389)
* docs: fixup docker compose test_utils * docs: iceberg writer close fn
1 parent 8068407 commit 1aa05e0

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

crates/iceberg/src/writer/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ pub trait IcebergWriter<I = DefaultInput, O = DefaultOutput>: Send + 'static {
7575
/// Close the writer and return the written data files.
7676
/// If close failed, the data written before maybe be lost. User may need to recreate the writer and rewrite the data again.
7777
/// # NOTE
78-
/// After close, no matter successfully or fail,the writer should never be used again, otherwise the writer will panic.
78+
/// After close, regardless of success or failure, the writer should never be used again, otherwise the writer will panic.
7979
async fn close(&mut self) -> Result<O>;
8080
}
8181

crates/test_utils/src/docker.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
use crate::cmd::{get_cmd_output, run_command};
1919
use std::process::Command;
2020

21-
/// A utility to manage lifecycle of docker compose.
21+
/// A utility to manage the lifecycle of `docker compose`.
2222
///
23-
/// It's will start docker compose when calling `run` method, and will be stopped when dropped.
23+
/// It will start `docker compose` when calling the `run` method and will be stopped via [`Drop`].
2424
#[derive(Debug)]
2525
pub struct DockerCompose {
2626
project_name: String,

0 commit comments

Comments
 (0)