[HOTFIX] Optimize the code style in csdk/sdk markdown doc #3030
Conversation
|
Build Failed with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/2253/ |
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/2046/ |
|
Build Success with Spark 2.3.2, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/10298/ |
|
retest this please |
|
Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/2265/ |
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/2061/ |
|
Build Success with Spark 2.3.2, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/10314/ |
docs/csdk-guide.md
Outdated
|
|
||
| ``` | ||
| /** | ||
| * Updates the hadoop configuration with the given key value |
There was a problem hiding this comment.
Please optimize it。
thanks 👍
docs/csdk-guide.md
Outdated
| */ | ||
| jobjectArray readNextBatchRow(); | ||
| /** | ||
| * read Next Batch Row |
There was a problem hiding this comment.
Please optimize this one.
thanks for review, I can not get your point,
|
add to whitelist |
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/2073/ |
|
Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/2278/ |
|
Build Success with Spark 2.3.2, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/10327/ |
|
LGTM |
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/2080/ |
|
Build Success with Spark 2.3.2, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/10334/ |
|
Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/2285/ |
docs/csdk-guide.md
Outdated
| */ | ||
| jobject builder(JNIEnv *env, char *path, char *tableName); | ||
| /** | ||
| * create a CarbonReaderBuilder object for building carbonReader, |
| jobject builder(JNIEnv *env, char *path, char *tableName); | ||
| /** | ||
| * create a CarbonReaderBuilder object for building carbonReader, | ||
| * CarbonReaderBuilder object can configure different parameter |
There was a problem hiding this comment.
remove one blank before 'can'
docs/csdk-guide.md
Outdated
| * */ | ||
| void builder(JNIEnv *env, char *path); | ||
| /** | ||
| * create a CarbonReaderBuilder object for building carbonReader, |
docs/csdk-guide.md
Outdated
| **/ | ||
| jobject withHadoopConf(int argc, char *argv[]); | ||
| /** | ||
| * build carbon reader with argument vector |
docs/csdk-guide.md
Outdated
| jobject withHadoopConf(int argc, char *argv[]); | ||
| /** | ||
| * build carbon reader with argument vector | ||
| * it support multiple parameter |
There was a problem hiding this comment.
support to supports
parameter to paramters
docs/csdk-guide.md
Outdated
| jobject build(); | ||
| /** | ||
| * build carbonReader object for reading data | ||
| * it support read data from load disk |
There was a problem hiding this comment.
build to Build
recommend: it supports to read data from load disk
docs/csdk-guide.md
Outdated
| */ | ||
| jobject readNextRow(); | ||
| /** | ||
| * read next carbonRow from data |
docs/csdk-guide.md
Outdated
| */ | ||
| jboolean close(); | ||
| /** | ||
| * close the carbon reader |
docs/csdk-guide.md
Outdated
| */ | ||
| void withLoadOption(char *key, char *value); | ||
| /** | ||
| * create a CarbonWriterBuilder object for building carbonWriter, |
docs/csdk-guide.md
Outdated
|
|
||
| ``` | ||
| /** | ||
| * sets the list of columns that needs to be in sorted order |
docs/csdk-guide.md
Outdated
|
|
||
| ``` | ||
| /** | ||
| * configure the schema with json style schema |
docs/csdk-guide.md
Outdated
| */ | ||
| void taskNo(long taskNo); | ||
| /** | ||
| * sets the taskNo for the writer. CSDKs concurrently running |
docs/csdk-guide.md
Outdated
| */ | ||
| void uniqueIdentifier(long timestamp); | ||
| /** | ||
| * to set the timestamp in the carbondata and carbonindex index files |
docs/csdk-guide.md
Outdated
| */ | ||
| void build(); | ||
| /** | ||
| * build carbonWriter object for writing data |
|
There are some other capitalization problems, please check and fix. |
thanks for detail review. I have update the doc |
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/2083/ |
|
Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/2288/ |
|
Build Success with Spark 2.3.2, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/10337/ |
|
LGTM! Thanks for your contribution! |
optimize backoff csdk-guide & sdk-guide doc code style This closes #3030
optimize backoff csdk-guide & sdk-guide doc code style This closes apache#3030
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 YES
Please provide details on
- Whether new unit test cases have been added or why no new tests are required?
- How it is tested? Please attach test report.
- Is it a performance related change? Please attach the performance test report.
- Any additional information to help reviewers in testing this change.
For large changes, please consider breaking it into sub-tasks under an umbrella JIRA. OK