You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/05/11 10:25:52 UTC

[PR] Improve repository readme [arrow-rs]

alamb opened a new pull request, #5752:
URL: https://github.com/apache/arrow-rs/pull/5752

   # Which issue does this PR close?
   
   <!--
   We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
   -->
   
   # Rationale for this change
    
   While working on https://github.com/apache/arrow-rs/pull/5737 and https://github.com/apache/arrow-rs/pull/5750 I noticed a few improvements that could be made to the repository readme.
   
   
   # What changes are included in this PR?
   
   Refine description and add more links to readme
   
   # Are there any user-facing changes?
   Docs
   
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!---
   If there are any breaking changes to public APIs, please add the `breaking change` label.
   -->
   


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


Re: [PR] Improve repository readme [arrow-rs]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #5752:
URL: https://github.com/apache/arrow-rs/pull/5752#discussion_r1597422115


##########
README.md:
##########
@@ -62,22 +69,30 @@ For example:
 
 There are two related crates in different repositories
 
-| Crate      | Description                             | Documentation                 |
-| ---------- | --------------------------------------- | ----------------------------- |
-| DataFusion | In-memory query engine with SQL support | [(README)][datafusion-readme] |
-| Ballista   | Distributed query execution             | [(README)][ballista-readme]   |
+| Crate          | Description                             | Documentation                 |
+| -------------- | --------------------------------------- | ----------------------------- |
+| [`datafusion`] | In-memory query engine with SQL support | [(README)][datafusion-readme] |
+| [`ballista`]   | Distributed query execution             | [(README)][ballista-readme]   |

Review Comment:
   Sounds good



##########
README.md:
##########
@@ -62,22 +69,30 @@ For example:
 
 There are two related crates in different repositories
 
-| Crate      | Description                             | Documentation                 |
-| ---------- | --------------------------------------- | ----------------------------- |
-| DataFusion | In-memory query engine with SQL support | [(README)][datafusion-readme] |
-| Ballista   | Distributed query execution             | [(README)][ballista-readme]   |
+| Crate          | Description                             | Documentation                 |
+| -------------- | --------------------------------------- | ----------------------------- |
+| [`datafusion`] | In-memory query engine with SQL support | [(README)][datafusion-readme] |
+| [`ballista`]   | Distributed query execution             | [(README)][ballista-readme]   |

Review Comment:
   Sounds good, thank you



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


Re: [PR] Improve repository readme [arrow-rs]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #5752:
URL: https://github.com/apache/arrow-rs/pull/5752#discussion_r1597420064


##########
README.md:
##########
@@ -62,22 +69,30 @@ For example:
 
 There are two related crates in different repositories
 
-| Crate      | Description                             | Documentation                 |
-| ---------- | --------------------------------------- | ----------------------------- |
-| DataFusion | In-memory query engine with SQL support | [(README)][datafusion-readme] |
-| Ballista   | Distributed query execution             | [(README)][ballista-readme]   |
+| Crate          | Description                             | Documentation                 |
+| -------------- | --------------------------------------- | ----------------------------- |
+| [`datafusion`] | In-memory query engine with SQL support | [(README)][datafusion-readme] |
+| [`ballista`]   | Distributed query execution             | [(README)][ballista-readme]   |

Review Comment:
   Sounds like a good idea to me -- is it mature enough to steer people to? The crates.io page makes it unclear
   
   https://crates.io/crates/object_store_opendal
   
   ![Screenshot 2024-05-11 at 6 32 25 AM](https://github.com/apache/arrow-rs/assets/490673/fee1279d-fa92-4afb-afce-fed3495b2fec)
   



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


Re: [PR] Improve repository readme [arrow-rs]

Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #5752:
URL: https://github.com/apache/arrow-rs/pull/5752#discussion_r1597418896


##########
README.md:
##########
@@ -62,22 +69,30 @@ For example:
 
 There are two related crates in different repositories
 
-| Crate      | Description                             | Documentation                 |
-| ---------- | --------------------------------------- | ----------------------------- |
-| DataFusion | In-memory query engine with SQL support | [(README)][datafusion-readme] |
-| Ballista   | Distributed query execution             | [(README)][ballista-readme]   |
+| Crate          | Description                             | Documentation                 |
+| -------------- | --------------------------------------- | ----------------------------- |
+| [`datafusion`] | In-memory query engine with SQL support | [(README)][datafusion-readme] |
+| [`ballista`]   | Distributed query execution             | [(README)][ballista-readme]   |

Review Comment:
   Hi, do you think it's a good idea to add `object_store_opendal` here as an integration to `object_store`? 



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


Re: [PR] Improve repository readme [arrow-rs]

Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #5752:
URL: https://github.com/apache/arrow-rs/pull/5752#discussion_r1597420489


##########
README.md:
##########
@@ -62,22 +69,30 @@ For example:
 
 There are two related crates in different repositories
 
-| Crate      | Description                             | Documentation                 |
-| ---------- | --------------------------------------- | ----------------------------- |
-| DataFusion | In-memory query engine with SQL support | [(README)][datafusion-readme] |
-| Ballista   | Distributed query execution             | [(README)][ballista-readme]   |
+| Crate          | Description                             | Documentation                 |
+| -------------- | --------------------------------------- | ----------------------------- |
+| [`datafusion`] | In-memory query engine with SQL support | [(README)][datafusion-readme] |
+| [`ballista`]   | Distributed query execution             | [(README)][ballista-readme]   |

Review Comment:
   > Sounds like a good idea to me -- is it mature enough to steer people to? The crates.io page makes it unclear
   
   Nice catch. I will improve this part and raising a PR later.



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


Re: [PR] Improve repository readme [arrow-rs]

Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #5752:
URL: https://github.com/apache/arrow-rs/pull/5752


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