Doctest for PrimitiveArray using from_iter_values. #694
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
Codecov Report
@@ Coverage Diff @@
## master #694 +/- ##
=======================================
Coverage 82.44% 82.44%
=======================================
Files 168 168
Lines 47347 47365 +18
=======================================
+ Hits 39033 39051 +18
Misses 8314 8314
Continue to review full report at Codecov.
|
Dandandan
reviewed
Aug 15, 2021
arrow/src/array/array_primitive.rs
Outdated
| /// ``` | ||
| /// use arrow::array::{Array, PrimitiveArray}; | ||
| /// use arrow::datatypes::Int32Type; | ||
| /// let arr: PrimitiveArray<Int32Type> = PrimitiveArray::from_iter_values(0..10); |
There was a problem hiding this comment.
Maybe the example could be slightly more complex to show that's not just a range?
E.g. (0..10).map(|x| x +1)?
alamb
reviewed
Aug 16, 2021
| /// for i in 0..10i32 { | ||
| /// assert_eq!(i + 1, arr.value(i as usize)); | ||
| /// } | ||
| /// ``` |
There was a problem hiding this comment.
I am also hoping we could document creating an array using collect such as
let arr : Int32Array = [Some(1), Some(2)].into_iter().collect();
I am not sure if that is already documented but this documentation on PrimitiveArray is already much better than nothing @novemberkilo 👍
Dandandan
approved these changes
Aug 18, 2021
alamb
pushed a commit
that referenced
this pull request
Aug 19, 2021
* Doctest for PrimitiveArray using from_iter_values. * Better example for building a PrimitiveArray.
alamb
added a commit
that referenced
this pull request
Aug 20, 2021
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?
re #302
// @alamb