-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MINOR: [R][Documentation] Add default descriptions in CsvParseOptions$create() docs #37909
MINOR: [R][Documentation] Add default descriptions in CsvParseOptions$create() docs #37909
Conversation
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format?
or
In the case of PARQUET issues on JIRA the title also supports:
See also: |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making this PR, @angela-li! I've rebuilt the docs and pushed it to the branch, so will merge shortly.
After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit 1bd3cba. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about possible false positives for unstable benchmarks that are known to sometimes produce them. |
…$create() docs (apache#37909) ### Rationale for this change Add more function documentation for folks who want to manually change `quote_char` or `escape_char` options in `CsvParseOptions$create()`, as I did in apache#37908. I had to go through the source code to arrow/r/R/csv.R - [line 587](https://github.com/apache/arrow/blob/7dc9f69a8a77345d0ec7920af9224ef96d7f5f78/r/R/csv.R#L587) to find the default argument, which was a pain. ### What changes are included in this PR? Documentation changes ### Are these changes tested? No - not changing underlying code. Maintainers might need to rebuild package to include these changes in man/ folder ### Are there any user-facing changes? Yes, on documentation of methods. Lead-authored-by: Angela Li <[email protected]> Co-authored-by: Nic Crane <[email protected]> Signed-off-by: Nic Crane <[email protected]>
…$create() docs (apache#37909) ### Rationale for this change Add more function documentation for folks who want to manually change `quote_char` or `escape_char` options in `CsvParseOptions$create()`, as I did in apache#37908. I had to go through the source code to arrow/r/R/csv.R - [line 587](https://github.com/apache/arrow/blob/7dc9f69a8a77345d0ec7920af9224ef96d7f5f78/r/R/csv.R#L587) to find the default argument, which was a pain. ### What changes are included in this PR? Documentation changes ### Are these changes tested? No - not changing underlying code. Maintainers might need to rebuild package to include these changes in man/ folder ### Are there any user-facing changes? Yes, on documentation of methods. Lead-authored-by: Angela Li <[email protected]> Co-authored-by: Nic Crane <[email protected]> Signed-off-by: Nic Crane <[email protected]>
…$create() docs (apache#37909) ### Rationale for this change Add more function documentation for folks who want to manually change `quote_char` or `escape_char` options in `CsvParseOptions$create()`, as I did in apache#37908. I had to go through the source code to arrow/r/R/csv.R - [line 587](https://github.com/apache/arrow/blob/7dc9f69a8a77345d0ec7920af9224ef96d7f5f78/r/R/csv.R#L587) to find the default argument, which was a pain. ### What changes are included in this PR? Documentation changes ### Are these changes tested? No - not changing underlying code. Maintainers might need to rebuild package to include these changes in man/ folder ### Are there any user-facing changes? Yes, on documentation of methods. Lead-authored-by: Angela Li <[email protected]> Co-authored-by: Nic Crane <[email protected]> Signed-off-by: Nic Crane <[email protected]>
…$create() docs (apache#37909) ### Rationale for this change Add more function documentation for folks who want to manually change `quote_char` or `escape_char` options in `CsvParseOptions$create()`, as I did in apache#37908. I had to go through the source code to arrow/r/R/csv.R - [line 587](https://github.com/apache/arrow/blob/7dc9f69a8a77345d0ec7920af9224ef96d7f5f78/r/R/csv.R#L587) to find the default argument, which was a pain. ### What changes are included in this PR? Documentation changes ### Are these changes tested? No - not changing underlying code. Maintainers might need to rebuild package to include these changes in man/ folder ### Are there any user-facing changes? Yes, on documentation of methods. Lead-authored-by: Angela Li <[email protected]> Co-authored-by: Nic Crane <[email protected]> Signed-off-by: Nic Crane <[email protected]>
Rationale for this change
Add more function documentation for folks who want to manually change
quote_char
orescape_char
options inCsvParseOptions$create()
, as I did in #37908.I had to go through the source code to arrow/r/R/csv.R - line 587 to find the default argument, which was a pain.
What changes are included in this PR?
Documentation changes
Are these changes tested?
No - not changing underlying code. Maintainers might need to rebuild package to include these changes in man/ folder
Are there any user-facing changes?
Yes, on documentation of methods.