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][Docs] Improve error message around add_filename #37372

Merged
merged 2 commits into from Aug 25, 2023

Conversation

amoeba
Copy link
Member

@amoeba amoeba commented Aug 24, 2023

Rationale for this change

Before this change, it's difficult for the user to not get stuck when they run into an error trying to use the result of add_filename in subsequent pipeline steps.

What changes are included in this PR?

  • Update error message string now includes advice
  • Updated docs page for add_filename including an example

Are these changes tested?

Yes. Tests were updated and confirmed to pass.

Are there any user-facing changes?

No.

Copy link
Member

@paleolimbot paleolimbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This is definitely an improvement. Technically you can do it without resolving the entire query result into memory using as_record_batch_reader() but that is pretty obscure and I don't think it needs to be recommended.

@github-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Aug 25, 2023
@amoeba
Copy link
Member Author

amoeba commented Aug 25, 2023

Yeah, I considered mentioning it but went with compute/collect since that felt more consistent. Thanks for the review.

@paleolimbot paleolimbot merged commit fa0af70 into apache:main Aug 25, 2023
11 checks passed
@paleolimbot paleolimbot removed the awaiting merge Awaiting merge label Aug 25, 2023
@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit fa0af70.

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.

loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
)

### Rationale for this change

Before this change, it's difficult for the user to not get stuck when they run into an error trying to use the result of add_filename in subsequent pipeline steps.

### What changes are included in this PR?

- Update error message string now includes advice
- Updated docs page for add_filename including an example

### Are these changes tested?

Yes. Tests were updated and confirmed to pass.

### Are there any user-facing changes?

No.

Authored-by: Bryce Mecum <petridish@gmail.com>
Signed-off-by: Dewey Dunnington <dewey@fishandwhistle.net>
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.

None yet

2 participants