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

More examples of how to construct Arrays #301

Closed
alamb opened this issue May 16, 2021 · 5 comments · Fixed by #338, #603 or #625
Closed

More examples of how to construct Arrays #301

alamb opened this issue May 16, 2021 · 5 comments · Fixed by #338, #603 or #625
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alamb
Copy link
Contributor

alamb commented May 16, 2021

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

Imagine a user who wants to make a StringArray. They go to the docs, and find StringArray
And now what?

Screen Shot 2021-05-16 at 7 42 57 AM

Describe the solution you'd like
Adding an example (or a pointer to such an example) to each of the Array types (e.g things that implement Array of how to construct them (from iterators) such as

let array = StringArray::from(vec![Some("foo"), None, Some("bar")]);

(and taking inspiration from the examples in the main docs https://docs.rs/arrow/4.0.0/arrow/index.html)

would probably be super helpful.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

@alamb alamb added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 16, 2021
@novemberkilo
Copy link
Contributor

Thanks for the write up @alamb - I will pick this up if that’s ok?

@novemberkilo
Copy link
Contributor

novemberkilo commented May 21, 2021

@alamb it looks like there are several other array types that do not have examples. Shall I continue in the same vein as #330 to annotate them with doctests?

For example, BooleanArray has no examples, and none of the methods appear to have documentation either.

https://docs.rs/arrow/4.0.0/arrow/array/struct.BooleanArray.html
https://docs.rs/arrow/4.0.0/arrow/array/struct.BooleanArray.html#method.builder

@alamb
Copy link
Contributor Author

alamb commented May 21, 2021

@novemberkilo yes I think adding examples / documentation to all the array types (including Boolean array) would be great!

Thank you so much

This was referenced May 22, 2021
@alamb
Copy link
Contributor Author

alamb commented May 25, 2021

Reopening as @novemberkilo has plans for additional PRs

@novemberkilo
Copy link
Contributor

keep-alive -- I'm still on this // @alamb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
2 participants