Docs: Improve the documentation on ScalarValue
#8378
Merged
Conversation
This file contains 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
changed the title
ScalarValueScalarValue
viirya
reviewed
Nov 30, 2023
viirya
reviewed
Nov 30, 2023
viirya
approved these changes
Nov 30, 2023
Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
github-actions
bot
removed
the
documentation
viirya
reviewed
Nov 30, 2023
Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
viirya
approved these changes
Dec 1, 2023
Dandandan
approved these changes
Dec 2, 2023
|
Thanks for all these doc improvements @alamb |
alamb
commented
Dec 3, 2023
| /// | ||
| /// # Null Handling | ||
| /// | ||
| /// `ScalarValue` represents null values in the same way as Arrow. Nulls are |
There was a problem hiding this comment.
FYI @jayzhan211 -- perhaps this can help explain some of how we can avoid using NullArray / ScalarValue::Null in the various list array functions
appletreeisyellow
pushed a commit
to appletreeisyellow/datafusion
that referenced
this pull request
Dec 14, 2023
* Minor: Improve the documentation on `ScalarValue` * Update datafusion/common/src/scalar.rs Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com> * Update datafusion/common/src/scalar.rs Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com> --------- Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
Part of #7013
Rationale for this change
Creating null
ScalarValues is confusing, and it came up internally in IOx, so I would like to improve the documentation to try and make this concept clearerWhat changes are included in this PR?
ScalarValuedocumentation and adds some examplesAre these changes tested?
Yes, doc tests
Are there any user-facing changes?
Better docs and examples