expand docs for FixedSizeListArray #4622
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
approved these changes
Aug 2, 2023
Comment on lines
70
to
72
| /// │ [C,NULL] │ │ 1 │ │ │ 0 │ │ NULL │ │ 2 | ||
| /// └─────────────┘ │ └───┘ ├───┤ ├──────┤ │ | ||
| /// | │ 0 │ │ NULL │ │ 3 |
There was a problem hiding this comment.
When an array element is null, the values can be anything (valid). So I suggest using ???? to show that the contents could be something unknown:
Suggested change
| /// │ [C,NULL] │ │ 1 │ │ │ 0 │ │ NULL │ │ 2 | |
| /// └─────────────┘ │ └───┘ ├───┤ ├──────┤ │ | |
| /// | │ 0 │ │ NULL │ │ 3 | |
| /// │ [C,NULL] │ │ 1 │ │ │ 0 │ │ ???? │ │ 2 | |
| /// └─────────────┘ │ └───┘ ├───┤ ├──────┤ │ | |
| /// | │ 0 │ │ ???? │ │ 3 |
| /// Logical Values │ Validity ├───┤ ├──────┤ │ | ||
| /// (nulls) │ │ 1 │ │ C │ │ 4 | ||
| /// │ ├───┤ ├──────┤ │ | ||
| /// │ │ 0 │ │ NULL │ │ 5 |
There was a problem hiding this comment.
Same thing here:
Suggested change
| /// │ │ 0 │ │ NULL │ │ 5 | |
| /// │ │ 0 │ │ ??? │ │ 5 |
| @@ -60,6 +113,9 @@ use std::sync::Arc; | |||
| /// assert_eq!( &[3, 4, 5], list1.as_any().downcast_ref::<Int32Array>().unwrap().values()); | |||
| /// assert_eq!( &[6, 7, 8], list2.as_any().downcast_ref::<Int32Array>().unwrap().values()); | |||
| /// ``` | |||
| /// | |||
| /// [`StringArray`]: crate::array::StringArray | |||
| /// An array of [fixed size arrays](https://arrow.apache.org/docs/format/Columnar.html#fixed-size-list-layout) | |||
There was a problem hiding this comment.
I think this link formatting is a little off
Suggested change
| /// An array of [fixed size arrays](https://arrow.apache.org/docs/format/Columnar.html#fixed-size-list-layout) | |
| /// [fixed size arrays]: https://arrow.apache.org/docs/format/Columnar.html#fixed-size-list-layout |
|
Pushed the recommended changes @alamb . Thanks for the review! |
|
Thank you |
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?
Relates to #4607
Rationale for this change
Added extra docs to FixedSizeListArray to document its logical and physical layout.
What changes are included in this PR?
Just docs
Are there any user-facing changes?
Noe
Noe