From 4c7fdbb6a0251e2accb8b832cc2f427882ce0665 Mon Sep 17 00:00:00 2001 From: Ray Liu Date: Sun, 27 Apr 2025 10:19:27 +0800 Subject: [PATCH] Add doc for TableCommit --- crates/iceberg/src/catalog/mod.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/crates/iceberg/src/catalog/mod.rs b/crates/iceberg/src/catalog/mod.rs index 6a1572a4a..d9755317a 100644 --- a/crates/iceberg/src/catalog/mod.rs +++ b/crates/iceberg/src/catalog/mod.rs @@ -268,6 +268,10 @@ pub struct TableCreation { } /// TableCommit represents the commit of a table in the catalog. +/// +/// The builder is marked as private since it's dangerous and error-prone to construct +/// [`TableCommit`] directly. +/// Users are supposed to use [`crate::transaction::Transaction`] to update table. #[derive(Debug, TypedBuilder)] #[builder(build_method(vis = "pub(crate)"))] pub struct TableCommit {