You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/05/16 11:45:05 UTC

[GitHub] [arrow-rs] alamb opened a new issue #301: More examples of how to construct Arrays

alamb opened a new issue #301:
URL: https://github.com/apache/arrow-rs/issues/301


   **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](https://docs.rs/arrow/4.0.0/arrow/array/type.StringArray.html)
   And now what?
   
   ![Screen Shot 2021-05-16 at 7 42 57 AM](https://user-images.githubusercontent.com/490673/118395815-6122af00-b61a-11eb-8bbc-55d30fd8afc1.png)
   
   **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](https://docs.rs/arrow/4.0.0/arrow/array/trait.Array.html) of how to construct them (from iterators) such as 
   
   ```
   let array = StringArray::from(vec![Some("foo"), None, Some("bar")]);
   ```
   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.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] novemberkilo edited a comment on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
novemberkilo edited a comment on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-845689692


   @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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] novemberkilo commented on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
novemberkilo commented on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-841807477


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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] novemberkilo commented on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
novemberkilo commented on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-878748738


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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb commented on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
alamb commented on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-846122991


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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb closed issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
alamb closed issue #301:
URL: https://github.com/apache/arrow-rs/issues/301


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] novemberkilo commented on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
novemberkilo commented on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-841807477


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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] novemberkilo edited a comment on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
novemberkilo edited a comment on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-845689692


   @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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb closed issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
alamb closed issue #301:
URL: https://github.com/apache/arrow-rs/issues/301


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] novemberkilo commented on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
novemberkilo commented on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-845689692


   @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?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow-rs] alamb commented on issue #301: More examples of how to construct Arrays

Posted by GitBox <gi...@apache.org>.
alamb commented on issue #301:
URL: https://github.com/apache/arrow-rs/issues/301#issuecomment-847740984


   Reopening as @novemberkilo  has plans for additional PRs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org