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/24 10:01:23 UTC
[GitHub] [arrow-rs] alamb opened a new issue #340: Improve main arrow README: explain project + provide an overview
alamb opened a new issue #340:
URL: https://github.com/apache/arrow-rs/issues/340
**Is your feature request related to a problem or challenge? Please describe what you are trying to do.**
If you look at the main landing page of https://crates.io/crates/arrow, you see something that looks mostly like a developer's guide rather than a users guide:
Including a bunch of stuff about `unsafe`
As a new potential user of arrow I would find this quite confusing
The source for this readme is at
https://github.com/apache/arrow-rs/tree/master/arrow
**Describe the solution you'd like**
I suggest adding the following sections (borrowing heavily from existing content), briefly:
1. What arrow is
2. What are some main usecases (so potential users can see if that matches what they need)
3. Some straightforward examples -- perhaps of building an array and then running a compute kernel on it
4. A link to a separate page with developer information
**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] jorgecarleitao commented on issue #340: Improve main arrow README: explain project + provide an overview
Posted by GitBox <gi...@apache.org>.
jorgecarleitao commented on issue #340:
URL: https://github.com/apache/arrow-rs/issues/340#issuecomment-846933599
Good finding. I would expect (assumed) that the content inside `lib.rs` to be in the landing page of the crate, not the `README.md`, which is typically used for developers.
--
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