Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The doc of GenericListArray is confusing #1424

Closed
HaoYang670 opened this issue Mar 11, 2022 · 0 comments · Fixed by #1450
Closed

The doc of GenericListArray is confusing #1424

HaoYang670 opened this issue Mar 11, 2022 · 0 comments · Fixed by #1450
Labels

Comments

@HaoYang670
Copy link
Contributor

HaoYang670 commented Mar 11, 2022

Describe the bug
https://github.com/apache/arrow-rs/blob/master/arrow/src/array/array_list.rs#L52

/// Generic struct for a primitive Array
///
/// For non generic lists, you may wish to consider using [`ListArray`] or [`LargeListArray`]`
pub struct GenericListArray<OffsetSize> {

The doc of GenericListArray says it is the struct for a primitive array, which makes me a little confused.
It is the generic type for Variable-size List Array, isn't it?

Came up when working on #1392

@HaoYang670 HaoYang670 added the bug label Mar 11, 2022
@HaoYang670 HaoYang670 changed the title Confusing doc of GenericListArray The doc of GenericListArray is confusing Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant