(iceberg) branch main updated: API: Fix Javadoc on UpdateSchema#updateColumnDoc (#9405)

[amoghj]

This is an automated email from the ASF dual-hosted git repository.

amoghj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/main by this push:
     new c19318e686 API: Fix Javadoc on UpdateSchema#updateColumnDoc (#9405)
c19318e686 is described below

commit c19318e6865f21c117ddb67df23da80984b52b44
Author: Amogh Jahagirdar <am...@tabular.io>
AuthorDate: Wed Jan 3 15:16:34 2024 -0800

    API: Fix Javadoc on UpdateSchema#updateColumnDoc (#9405)
---
 api/src/main/java/org/apache/iceberg/UpdateSchema.java | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/api/src/main/java/org/apache/iceberg/UpdateSchema.java 
b/api/src/main/java/org/apache/iceberg/UpdateSchema.java
index 94bd6db8ae..afe1891cd5 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 @@ public interface UpdateSchema extends 
PendingUpdate<Schema> {
   }
 
   /**
-   * 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);