Skip to content
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

Merged
merged 2 commits into from
Sep 29, 2023

Conversation

angela-li
Copy link
Contributor

@angela-li angela-li commented Sep 27, 2023

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 #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.

@github-actions
Copy link

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?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

In the case of PARQUET issues on JIRA the title also supports:

PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

See also:

@angela-li angela-li changed the title Add default descriptions in CsvParseOptions$create() docs GH-37908: [R][Documentation] Add default descriptions in CsvParseOptions$create() docs Sep 27, 2023
@github-actions
Copy link

⚠️ GitHub issue #37908 has been automatically assigned in GitHub to PR creator.

@angela-li angela-li changed the title GH-37908: [R][Documentation] Add default descriptions in CsvParseOptions$create() docs MINOR: [R][Documentation] Add default descriptions in CsvParseOptions$create() docs Sep 27, 2023
Copy link
Member

@thisisnic thisisnic left a 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.

@github-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Sep 29, 2023
@thisisnic thisisnic merged commit 1bd3cba into apache:main Sep 29, 2023
11 checks passed
@thisisnic thisisnic removed the awaiting merge Awaiting merge label Sep 29, 2023
@conbench-apache-arrow
Copy link

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.

@angela-li angela-li deleted the GH-37908_opendataset-quote-char branch October 1, 2023 20:32
JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request Oct 23, 2023
…$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]>
JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request Oct 23, 2023
…$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]>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
…$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]>
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…$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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants