[GitHub] [incubator-hudi] hddong commented on a change in pull request #1111: [HUDI-331]Fix java docs for all public apis in HoodieWriteClient

[GitBox <gi...@apache.org>]

hddong commented on a change in pull request #1111: [HUDI-331]Fix java docs for all public apis in HoodieWriteClient
URL: https://github.com/apache/incubator-hudi/pull/1111#discussion_r360811318
 
 

 ##########
 File path: hudi-client/src/main/java/org/apache/hudi/HoodieWriteClient.java
 ##########
 @@ -509,13 +540,21 @@ private Partitioner getPartitioner(HoodieTable table, boolean isUpsert, Workload
 
   /**
    * Commit changes performed at the given commitTime marker.
+   *
+   * @param commitTime Commit Time handle
+   * @param writeStatuses RDD of WriteStatus to inspect errors and counts
+   * @return {@code true} if commit is successful. {@code false} otherwise
    */
   public boolean commit(String commitTime, JavaRDD<WriteStatus> writeStatuses) {
     return commit(commitTime, writeStatuses, Option.empty());
   }
 
   /**
    * Commit changes performed at the given commitTime marker.
+   * @param commitTime Commit Time handle
+   * @param writeStatuses RDD of WriteStatus to inspect errors and counts
 
 Review comment:
   > Again, not sure if we need to describe the data type in english for the parameters.. lets keep it high level?
   
   I wanted to keep context consistent, and fix all.

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services