Minor: Improve documentation about ColumnarValues::values_to_array
#9774
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alamb
added
documentation
viirya
reviewed
Mar 24, 2024
viirya
reviewed
Mar 24, 2024
viirya
approved these changes
Mar 24, 2024
Co-authored-by: Liang-Chi Hsieh <[email protected]>
github-actions
bot
added
logical-expr
Contributor
Author
|
Thank you for the review @viirya |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Related to #9773
Rationale for this change
Bugs like #9773 result from calling
ColumnarValue::into_arrayincorrectly and are suble, and likely will only be caught with tests. Let's try and direct poeple to the correct APIs (which are easier anyways)What changes are included in this PR?
Update docs to direct people to the correct API
Are these changes tested?
Existing doc tests
Are there any user-facing changes?