diff --git a/api/src/main/java/org/apache/iceberg/UpdateSchema.java b/api/src/main/java/org/apache/iceberg/UpdateSchema.java index 94bd6db8ae37..afe1891cd530 100644 --- a/api/src/main/java/org/apache/iceberg/UpdateSchema.java +++ b/api/src/main/java/org/apache/iceberg/UpdateSchema.java @@ -281,18 +281,15 @@ default UpdateSchema updateColumn(String name, Type.PrimitiveType newType, Strin } /** - * Update a column in the schema to a new primitive type. + * Update the documentation string for a column. * *
The name is used to find the column to update using {@link Schema#findField(String)}. * - *
Columns may be updated and renamed in the same schema update. - * - * @param name name of the column to rename + * @param name name of the column to update the documentation string for * @param newDoc replacement documentation string for the column * @return this for method chaining - * @throws IllegalArgumentException If name doesn't identify a column in the schema or if this - * change introduces a type incompatibility or if it conflicts with other additions, renames, - * or updates. + * @throws IllegalArgumentException If name doesn't identify a column in the schema or if the + * column will be deleted */ UpdateSchema updateColumnDoc(String name, String newDoc);