Skip to content

Commit f9061cc

Browse files
Add doc for TableCommit (#1263)
## Which issue does this PR close? - Closes #1262 . ## What changes are included in this PR? Update doc. ## Are these changes tested? No.
1 parent 111d0f3 commit f9061cc

File tree

1 file changed

+4
-0
lines changed
  • crates/iceberg/src/catalog

1 file changed

+4
-0
lines changed

crates/iceberg/src/catalog/mod.rs

+4
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,10 @@ pub struct TableCreation {
268268
}
269269

270270
/// TableCommit represents the commit of a table in the catalog.
271+
///
272+
/// The builder is marked as private since it's dangerous and error-prone to construct
273+
/// [`TableCommit`] directly.
274+
/// Users are supposed to use [`crate::transaction::Transaction`] to update table.
271275
#[derive(Debug, TypedBuilder)]
272276
#[builder(build_method(vis = "pub(crate)"))]
273277
pub struct TableCommit {

0 commit comments

Comments
 (0)