[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-30 Thread asfgit
Github user asfgit closed the pull request at:

https://github.com/apache/carbondata/pull/2915


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-28 Thread xubo245
Github user xubo245 commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r237331893
  
--- Diff: docs/sdk-guide.md ---
@@ -709,37 +749,7 @@ Find example code at 
[CarbonReaderExample](https://github.com/apache/carbondata/
   public  CarbonReader build();
 ```
 ### Class org.apache.carbondata.sdk.file.CarbonSchemaReader
--- End diff --

ok, done


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-28 Thread xubo245
Github user xubo245 commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r237330717
  
--- Diff: docs/sdk-guide.md ---
@@ -478,6 +489,16 @@ public CarbonWriter build() throws IOException, 
InvalidLoadOptionException;
 ```
 
 ### Class org.apache.carbondata.sdk.file.CarbonWriter
+
--- End diff --

because it should builder, build, and then colse when user use the API, so 
it's better that the doc should keep the same order


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-28 Thread sraghunandan
Github user sraghunandan commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r237042065
  
--- Diff: docs/sdk-guide.md ---
@@ -478,6 +489,16 @@ public CarbonWriter build() throws IOException, 
InvalidLoadOptionException;
 ```
 
 ### Class org.apache.carbondata.sdk.file.CarbonWriter
+
--- End diff --

why we changed the order?


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-28 Thread sraghunandan
Github user sraghunandan commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r237041556
  
--- Diff: docs/sdk-guide.md ---
@@ -709,37 +749,7 @@ Find example code at 
[CarbonReaderExample](https://github.com/apache/carbondata/
   public  CarbonReader build();
 ```
 ### Class org.apache.carbondata.sdk.file.CarbonSchemaReader
--- End diff --

it is better to mark as deprecated and remove in next version


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-22 Thread xubo245
Github user xubo245 commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r235834831
  
--- Diff: docs/sdk-guide.md ---
@@ -674,6 +693,16 @@ Find example code at 
[CarbonReaderExample](https://github.com/apache/carbondata/
   public CarbonReaderBuilder filter(Expression filterExpression);
 ```
 
+```
+  /**
+   * set read batch size before build
--- End diff --

ok, done


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-22 Thread xubo245
Github user xubo245 commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r235703636
  
--- Diff: docs/sdk-guide.md ---
@@ -684,6 +713,17 @@ Find example code at 
[CarbonReaderExample](https://github.com/apache/carbondata/
  public CarbonReaderBuilder withHadoopConf(Configuration conf);
 ```
 
+```
+  /**
+   * configure hadoop configuration with key value
--- End diff --

ok, done


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-22 Thread KanakaKumar
Github user KanakaKumar commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r235648435
  
--- Diff: docs/sdk-guide.md ---
@@ -674,6 +693,16 @@ Find example code at 
[CarbonReaderExample](https://github.com/apache/carbondata/
   public CarbonReaderBuilder filter(Expression filterExpression);
 ```
 
+```
+  /**
+   * set read batch size before build
--- End diff --

Sets the batch size of records


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-22 Thread KanakaKumar
Github user KanakaKumar commented on a diff in the pull request:

https://github.com/apache/carbondata/pull/2915#discussion_r235645252
  
--- Diff: docs/sdk-guide.md ---
@@ -684,6 +713,17 @@ Find example code at 
[CarbonReaderExample](https://github.com/apache/carbondata/
  public CarbonReaderBuilder withHadoopConf(Configuration conf);
 ```
 
+```
+  /**
+   * configure hadoop configuration with key value
--- End diff --

Change to "Updates the hadoop configuration with the given key value"


---


[GitHub] carbondata pull request #2915: [CARBONDATA-3095] Optimize the documentation ...

2018-11-13 Thread xubo245
GitHub user xubo245 opened a pull request:

https://github.com/apache/carbondata/pull/2915

[CARBONDATA-3095] Optimize the documentation of SDK/CSDK

Be sure to do all of the following checklist to help us incorporate 
your contribution quickly and easily:

 - [ ] Any interfaces changed?
 No
 - [ ] Any backward compatibility impacted?
 No
 - [ ] Document update required?
Yes
 - [ ] Testing done
No need
 - [ ] For large changes, please consider breaking it into sub-tasks under 
an umbrella JIRA. 
Jira-2951


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/xubo245/carbondata CARBONDATA-3095_OptimizeDoc

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/carbondata/pull/2915.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #2915


commit 18cfd99905ca67b43b948fe90f8032c619ed4e9d
Author: xubo245 
Date:   2018-11-13T12:24:08Z

[CARBONDATA-3095] Optimize the documentation of SDK/CSDK




---