Skip to content

Commit

Permalink
docs(writer/docker): fix small typos and wording (#389)
Browse files Browse the repository at this point in the history
* docs: fixup docker compose test_utils

* docs: iceberg writer close fn
  • Loading branch information
jdockerty authored Jun 2, 2024
1 parent 8068407 commit 1aa05e0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion crates/iceberg/src/writer/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
}

Expand Down
4 changes: 2 additions & 2 deletions crates/test_utils/src/docker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 1aa05e0

Please sign in to comment.