amogh-jahagirdar commented on code in PR #17523:
URL: https://github.com/apache/iceberg/pull/17523#discussion_r4555539110


##########
api/src/main/java/org/apache/iceberg/Snapshot.java:
##########
@@ -166,10 +166,26 @@ default Iterable<DeleteFile> removedDeleteFiles(FileIO 
io) {
   /**
    * Return the location of this snapshot's manifest list, or null if it is 
not separate.
    *
-   * @return the location of the manifest list for this Snapshot
+   * <p>Only set for tables with format version 1 through 3. Snapshots in v4 
tables use {@link
+   * #rootManifestLocation()} instead.

Review Comment:
   I think we can drop the new paragraph and just extend the existing first 
sentence. Technically "only set for v1 through 3" also isn't quite right, since 
v1 snapshots with embedded manifests don't set it either.
   
   ```java
      * Return the location of this snapshot's manifest list, or null if it is 
not separate or this
      * snapshot has a root manifest.
   ```



##########
api/src/main/java/org/apache/iceberg/Snapshot.java:
##########
@@ -166,10 +166,26 @@ default Iterable<DeleteFile> removedDeleteFiles(FileIO 
io) {
   /**
    * Return the location of this snapshot's manifest list, or null if it is 
not separate.
    *
-   * @return the location of the manifest list for this Snapshot
+   * <p>Only set for tables with format version 1 through 3. Snapshots in v4 
tables use {@link
+   * #rootManifestLocation()} instead.
+   *
+   * @return the location of the manifest list for this snapshot
    */
   String manifestListLocation();
 
+  /**
+   * Return the location of this snapshot's root manifest, or null if this 
snapshot has no root
+   * manifest.
+   *
+   * <p>v4 snapshots store this in {@code root-manifest} instead of a manifest 
list. At most one of
+   * this and {@link #manifestListLocation()} is set.

Review Comment:
   Could we just keep the first sentence here? The second paragraph repeats 
what `manifestListLocation()` already covers, and `{@code root-manifest}` is 
the JSON field name, which doesn't need to be in the API docs.
   
   ```java
     /**
      * Return the location of this snapshot's root manifest, or null if it has 
no root manifest.
      *
      * @return the location of the root manifest for this snapshot
      */
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to