Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(writer/docker): fix small typos and wording #389

Merged
merged 2 commits into from
Jun 2, 2024
Merged

docs(writer/docker): fix small typos and wording #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e03681
docs: fixup docker compose test_utils
jdockerty Jun 1, 2024
11b5bdb
docs: iceberg writer close fn
jdockerty Jun 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/iceberg/src/writer/mod.rs
View file
Open in desktop
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
View file
Open in desktop
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
Loading