This is an automated email from the ASF dual-hosted git repository.
akashrn5 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/carbondata.git
The following commit(s) were added to refs/heads/master by this push:
new 5a5ef9f [CARBONDATA-3713] update SDK doc about sort columns
5a5ef9f is described below
commit 5a5ef9f090ff3ce4459fbb0099532fcb9d08bf87
Author: ajantha-bhat <[email protected]>
AuthorDate: Sat May 9 13:08:11 2020 +0530
[CARBONDATA-3713] update SDK doc about sort columns
Why is this PR needed?
sort columns API information is wrong in SDK and CSDK
What changes were proposed in this PR?
update the correct information
This closes #3758
---
docs/csdk-guide.md | 3 +--
docs/sdk-guide.md | 3 +--
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/docs/csdk-guide.md b/docs/csdk-guide.md
index ef3f252..8467619 100644
--- a/docs/csdk-guide.md
+++ b/docs/csdk-guide.md
@@ -201,8 +201,7 @@ void outputPath(char *path);
*
* @param argc argc argument counter, the number of projection column
* @param argv argv is a string array of columns that needs to be sorted.
- * If it is null or by default all dimensions are selected
for sorting
- * If it is empty array, no columns are sorted
+ * If it is null or empty array, no columns are selected for
sorting.
*/
void sortBy(int argc, char *argv[]);
```
diff --git a/docs/sdk-guide.md b/docs/sdk-guide.md
index a912a07..8949fd0 100644
--- a/docs/sdk-guide.md
+++ b/docs/sdk-guide.md
@@ -316,8 +316,7 @@ public CarbonWriterBuilder localDictionaryThreshold(int
localDictionaryThreshold
* Sets the list of columns that needs to be in sorted order
*
* @param sortColumns is a string array of columns that needs to be sorted.
- * If it is null or by default all dimensions are selected
for sorting
- * If it is empty array, no columns are sorted
+ * If it is null or empty array, no columns are selected
for sorting.
* @return updated CarbonWriterBuilder
*/
public CarbonWriterBuilder sortBy(String[] sortColumns);
