[GitHub] [hudi] jkdll opened a new issue #2760: [SUPPORT] Possibly Incorrect Documentation

[GitBox]

jkdll opened a new issue #2760:
URL: https://github.com/apache/hudi/issues/2760


   Hi,
   I am using the HudiWriteClient library and have been following the 
documentation at [this 
link](https://hudi.apache.org/docs/configurations.html#writeclient-configs) to 
instantiate the HoodieWriteConfig object.
   
   The documentation indicates that the WriteConfig can define the 
[withAssumeDatePartitioning](https://hudi.apache.org/docs/configurations.html#withAssumeDatePartitioning)
 attribute. However upon further inspection, it turns out that this attribute 
is not present [in the HoodieWriteConfig 
class.](https://github.com/apache/hudi/blob/master/hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java).
 Instead this field looks to be present in 
[HoodieMetaDataConifg](https://github.com/apache/hudi/blob/03668dbaf1a60428d7e0d68c6622605e0809150a/hudi-common/src/main/java/org/apache/hudi/common/config/HoodieMetadataConfig.java).
   
   Similarly 
[withConsistencyCheckEnabled](https://hudi.apache.org/docs/configurations.html#withConsistencyCheckEnabled)
 is also not in the HoodieWriteConfig class and its 
[usage](https://github.com/apache/hudi/blob/03668dbaf1a60428d7e0d68c6622605e0809150a/hudi-client/hudi-spark-client/src/test/java/org/apache/hudi/testutils/HoodieClientTestBase.java#L146)
 is not properly documented.
   
   
   Versions from Pom.xml:
   `
   <!-- https://mvnrepository.com/artifact/org.apache.hudi/hudi-java-client -->
           <dependency>
               <groupId>org.apache.hudi</groupId>
               <artifactId>hudi-java-client</artifactId>
               <version>0.7.0</version>
           </dependency>
           <!-- 
https://mvnrepository.com/artifact/org.apache.hudi/hudi-client-common -->
           <dependency>
               <groupId>org.apache.hudi</groupId>
               <artifactId>hudi-client-common</artifactId>
               <version>0.7.0</version>
           </dependency>
           <!-- https://mvnrepository.com/artifact/org.apache.hudi/hudi-client 
-->
           <dependency>
               <groupId>org.apache.hudi</groupId>
               <artifactId>hudi-client</artifactId>
               <version>0.7.0</version>
               <type>pom</type>
           </dependency>
   `
   
   Thus I suggest that the documentation is updated.
   
   Thanks,


-- 
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:
us...@infra.apache.org