rdblue commented on code in PR #15049:
URL: https://github.com/apache/iceberg/pull/15049#discussion_r2898323993
##########
api/src/main/java/org/apache/iceberg/FileContent.java:
##########
@@ -18,11 +18,18 @@
*/
package org.apache.iceberg;
-/** Content type stored in a file, one of DATA, POSITION_DELETES, or
EQUALITY_DELETES. */
+/** Content type stored in a file. */
public enum FileContent {
+ /** Data file content. Stored in data manifests since v1. */
Review Comment:
I think that the docs here are too specific and aren't adding much value.
Here, for example, "data file content" duplicates "file content". A more
useful description is "A data file", but I don't think that is really
necessary. The content of the file this is attached to is "data" -- that's
already clear.
The additional symbols are also good: file content is a "data manifest", or
file content is a "delete manifest".
Also, this was not stored in data manifests since v1. All files in v1 were
data files, but this was not stored anywhere. This is one reason why
over-specifying in docs is a problem. The other problem is that you have to
remember to come back here and update it if you include requirements or
assumptions. The best practice is it be very simple and not add anything you
don't need to.
--
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]
