Skip to content

Commit aea08ec

Browse files
committed
docs: clarify table write API docstrings
1 parent 2dadcdf commit aea08ec

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

pyiceberg/table/__init__.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1378,7 +1378,7 @@ def append(self, df: pa.Table, snapshot_properties: dict[str, str] = EMPTY_DICT,
13781378
Shorthand API for appending a PyArrow table to the table.
13791379
13801380
Args:
1381-
df: The Arrow dataframe that will be appended to overwrite the table
1381+
df: The Arrow dataframe that will be appended to the table
13821382
snapshot_properties: Custom properties to be added to the snapshot summary
13831383
branch: Branch Reference to run the append operation
13841384
"""
@@ -1466,6 +1466,9 @@ def add_files(
14661466
14671467
Args:
14681468
file_paths: The list of full file paths to be added as data files to the table
1469+
snapshot_properties: Custom properties to be added to the snapshot summary
1470+
check_duplicate_files: Whether to check if the files are already present in the table
1471+
branch: Branch Reference to run the add-files operation
14691472
14701473
Raises:
14711474
FileNotFoundError: If the file does not exist.
@@ -1479,6 +1482,11 @@ def add_files(
14791482
)
14801483

14811484
def update_spec(self, case_sensitive: bool = True) -> UpdateSpec:
1485+
"""Create a new UpdateSpec to update the partitioning of the table.
1486+
1487+
Args:
1488+
case_sensitive: Whether column name matching should be case-sensitive.
1489+
"""
14821490
return UpdateSpec(Transaction(self, autocommit=True), case_sensitive=case_sensitive)
14831491

14841492
def refs(self) -> dict[str, SnapshotRef]:

0 commit comments

Comments
 (0)