Refine documentation for unary_mut and binary_mut
#5798
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
tustvold
reviewed
May 24, 2024
tustvold
reviewed
May 24, 2024
tustvold
reviewed
May 24, 2024
alamb
commented
May 24, 2024
| @@ -480,6 +480,19 @@ pub use crate::types::ArrowPrimitiveType; | |||
| /// assert_eq!(array.values(), &[1, 0, 2]); | |||
| /// assert!(array.is_null(1)); | |||
| /// ``` | |||
| /// | |||
| /// # Example: Get a `PrimitiveArray` from an [`ArrayRef`] | |||
There was a problem hiding this comment.
I don't think it is obvious how to go from Arc<dyn Array> back to PrimitiveArray so I documented that too
| /// # fn main() { | ||
| /// let array = Int32Array::from(vec![Some(5), Some(7), None]); | ||
| /// let c = array.unary(|x| x * 2 + 1); | ||
| /// assert_eq!(c, Int32Array::from(vec![Some(11), Some(15), None])); | ||
| /// // Create a new array with the value of applying sqrt |
There was a problem hiding this comment.
changed this to show you can make a different type
| /// assert_eq!(c, Int32Array::from(vec![Some(11), Some(15), None])); | ||
| /// ``` | ||
| /// | ||
| /// # Example: modify [`ArrayRef`] in place, if not shared |
There was a problem hiding this comment.
This is an example I imagine someone might be looking for (like I would be)
wiedld
reviewed
May 28, 2024
|
I think this PR is ready for review I have filed #5770 to track the "binary_mut" type check |
|
I believe CI is failing due to #5815 |
|
I plan to merge this PR in the next day or two unless there is any additional commentary. It adds test coverage and changes docs -- if we find issues or additional improvements we can do them as follow on PRs |
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?
N/A
Rationale for this change
I ran into someone at a conference yesterday who was saying they hadn't been
able to figure out how to modify arrays in place. @tustvold pointed out to me it
is possible but the documentation for
binary_mutandunary_mutwasnot as clear as it could be,
I had the code up for #5792 anyways so I figured I would bang out this improvement as well
What changes are included in this PR?
This ended up being larger than I expected as I opened the docs and was imaginging "how would a random person who didn't understand the details of arrow-rs use this feature"
Are there any user-facing changes?
Doc changes only, no code changes