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

Document from_iter methods and #302

Closed
alamb opened this issue May 16, 2021 · 6 comments
Closed

Document from_iter methods and #302

alamb opened this issue May 16, 2021 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

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.
Users can create arrow arrays in one of two ways:

  1. Directly from an Iterator or vec (via methods such as from_iter and this we can use collect())
  2. Using a builder (something that implements ArrayBuilder)

Typically the from_iterator method is both easier to use and faster, but it is not well documented in the doc strings

Describe the solution you'd like

  1. Add doc examples for from_iter methods (we can file additional issues for subsets of these iterators)
  2. Add doc examples for the builders (such as https://docs.rs/arrow/4.0.0/arrow/array/struct.BooleanBuilder.html) and also link to the from_iter methods
@alamb alamb added the documentation Improvements or additions to documentation label May 16, 2021
@novemberkilo
Copy link
Contributor

Am also good to run with this. Please assign to me as appropriate. Thanks @alamb

@alamb
Copy link
Contributor Author

alamb commented May 16, 2021

BTW @novemberkilo there are probably lots of good examples to from the tests that can be pulled into the doc examples

@novemberkilo
Copy link
Contributor

@alamb I'm not sure what else I should try and cover in this issue. Can you please help identify what the gap is to closing this issue? Thanks.

@alamb
Copy link
Contributor Author

alamb commented Aug 16, 2021

Thanks @novemberkilo -- basically I think this is a very common pattern when using Arrow to create arrays via the collect method:

let arr : Int32Array = [Some(1), Some(2)].into_iter().collect();

I am not sure if that is already documented

@novemberkilo
Copy link
Contributor

Roger - will add such to examples 👍🏽

@ByteBaker
Copy link
Contributor

@alamb can we close this probably?

@alamb alamb closed this as completed Oct 3, 2024
@alamb alamb reopened this Oct 3, 2024
@alamb alamb closed this as not planned Won't fix, can't repro, duplicate, stale Oct 3, 2024
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
Projects
None yet
Development

No branches or pull requests

3 participants