You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/09/10 13:21:09 UTC
[PR] Improve comments on target user and unify intro summaries [datafusion]
alamb opened a new pull request, #12418:
URL: https://github.com/apache/datafusion/pull/12418
## Which issue does this PR close?
Related to https://github.com/apache/datafusion/issues/12357
## Rationale for this change
Inspired by @phillipleblanc's comment on https://github.com/apache/datafusion/issues/12357#issuecomment-2335401127 let's make it clearer that DataFusion is targeted at people building other systems
While I was working on this, it also became clear the DataFusion summary / intro had diverged so I unified it again
## What changes are included in this PR?
Changes:
1. Clarify that DataFusion is targeted at people building other systems
2. Ensure that the readme, user guide and library .rs are all in sync
## Are these changes tested?
By CI
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
## Are there any user-facing changes?
No functional change, only doc chages
<!--
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 `api 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@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Improve comments on target user and unify intro summaries [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #12418:
URL: https://github.com/apache/datafusion/pull/12418
--
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@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Improve comments on target user and unify intro summaries [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #12418:
URL: https://github.com/apache/datafusion/pull/12418#issuecomment-2346670106
Thanks again @phillipleblanc and @comphead for reviewing this. Let's keep iterating on the docs as follow on PRs too.
--
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@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Improve comments on target user and unify intro summaries [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #12418:
URL: https://github.com/apache/datafusion/pull/12418#discussion_r1751950975
##########
README.md:
##########
@@ -40,9 +40,28 @@
<img src="./docs/source/_static/images/2x_bgwhite_original.png" width="512" alt="logo"/>
-Apache DataFusion is a very fast, extensible query engine for building high-quality data-centric systems in
-[Rust](http://rustlang.org), using the [Apache Arrow](https://arrow.apache.org)
-in-memory format. [Python Bindings](https://github.com/apache/datafusion-python) are also available. DataFusion offers SQL and Dataframe APIs, excellent [performance](https://benchmark.clickhouse.com/), built-in support for CSV, Parquet, JSON, and Avro, extensive customization, and a great community.
+DataFusion is an extensible query engine written in [Rust] that
Review Comment:
This is now the same as in lib.rs
##########
datafusion/core/src/lib.rs:
##########
@@ -17,24 +17,28 @@
#![warn(missing_docs, clippy::needless_borrow)]
//! [DataFusion] is an extensible query engine written in Rust that
Review Comment:
I clarified this text and made it consistent with the other intros
##########
README.md:
##########
@@ -40,9 +40,28 @@
<img src="./docs/source/_static/images/2x_bgwhite_original.png" width="512" alt="logo"/>
-Apache DataFusion is a very fast, extensible query engine for building high-quality data-centric systems in
-[Rust](http://rustlang.org), using the [Apache Arrow](https://arrow.apache.org)
-in-memory format. [Python Bindings](https://github.com/apache/datafusion-python) are also available. DataFusion offers SQL and Dataframe APIs, excellent [performance](https://benchmark.clickhouse.com/), built-in support for CSV, Parquet, JSON, and Avro, extensive customization, and a great community.
+DataFusion is an extensible query engine written in [Rust] that
Review Comment:
While it is redundant to have the same content in three places I think it is worthwhile as the three places are the three most common "landing" pages for people with DataFusion:
1. The main website https://datafusion.apache.org/
2. The docs.rs page: https://docs.rs/datafusion/latest/datafusion/index.html
3. The github repo: https://github.com/apache/datafusion/
##########
docs/source/index.rst:
##########
@@ -32,14 +32,23 @@ Apache DataFusion
<a class="github-button" href="https://github.com/apache/datafusion/fork" data-size="large" data-show-count="true" aria-label="Fork apache/datafusion on GitHub">Fork</a>
</p>
-DataFusion is a very fast, extensible query engine for building high-quality data-centric systems in
-`Rust <http://rustlang.org>`_, using the `Apache Arrow <https://arrow.apache.org>`_
-in-memory format.
-
-DataFusion offers SQL and Dataframe APIs, excellent
-`performance <https://benchmark.clickhouse.com>`_, built-in support for
-CSV, Parquet, JSON, and Avro, extensive customization, and a great
-community.
+
+DataFusion is an extensible query engine written in `Rust <http://rustlang.org>`_ that
Review Comment:
I think it could be argued that we should move this content out of the github readme.md leave a link to the main website https://datafusion.apache.org/ 🤔
--
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@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org