vinothchandar 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_r360676113
##########
File path: hudi-client/src/main/java/org/apache/hudi/HoodieWriteClient.java
##########
@@ -108,14 +108,17 @@
private transient Timer.Context indexTimer = null;
/**
- *
+ * @param jsc Java Spark Context
+ * @param clientConfig instance of HoodieWriteConfig
*/
- public HoodieWriteClient(JavaSparkContext jsc, HoodieWriteConfig
clientConfig) throws Exception {
+ public HoodieWriteClient(JavaSparkContext jsc, HoodieWriteConfig
clientConfig) {
this(jsc, clientConfig, false);
}
/**
- *
+ * @param jsc Java Spark Context
Review comment:
nit: `Constructor function` seems little obvious.. Lets change both to
`Creates a write client, without cleaning up failed/inflight commits` ..
In general, let's just describe important behavioral things...
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
