Skip to content

Commit

Permalink
API: Fix Javadoc on UpdateSchema#updateColumnDoc (apache#9405)
Browse files Browse the repository at this point in the history
  • Loading branch information
amogh-jahagirdar authored Jan 3, 2024
1 parent 8c7001e commit c19318e
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions api/src/main/java/org/apache/iceberg/UpdateSchema.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>The name is used to find the column to update using {@link Schema#findField(String)}.
*
* <p>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);

Expand Down

0 comments on commit c19318e

Please sign in to comment.