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 FixedSizeListArray::value_length is incorrect. #1908

Closed
HaoYang670 opened this issue Jun 19, 2022 · 1 comment · Fixed by #1957
Closed

The doc of FixedSizeListArray::value_length is incorrect. #1908

HaoYang670 opened this issue Jun 19, 2022 · 1 comment · Fixed by #1957
Labels
arrow Changes to the arrow crate documentation Improvements or additions to documentation

Comments

@HaoYang670
Copy link
Contributor

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

    /// Returns the length for value at index `i`.
    ///
    /// Note this doesn't do any bound checking, for performance reason.
    #[inline]
    pub const fn value_length(&self) -> i32 {
        self.length
    }

The doc is incorrect

Expected behavior
Correct the doc.

@HaoYang670 HaoYang670 added the bug label Jun 19, 2022
@HaoYang670
Copy link
Contributor Author

This could be a good first issue for people who want to learn the data structure of FixedSizeListArray

@alamb alamb added documentation Improvements or additions to documentation arrow Changes to the arrow crate and removed bug labels Jul 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants