Improve comments on target user and unify intro summaries #12418
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alamb
commented
Sep 10, 2024
| 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 |
There was a problem hiding this comment.
This is now the same as in lib.rs
There was a problem hiding this 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:
- The main website https://datafusion.apache.org/
- The docs.rs page: https://docs.rs/datafusion/latest/datafusion/index.html
- The github repo: https://github.com/apache/datafusion/
| @@ -17,24 +17,28 @@ | |||
| #![warn(missing_docs, clippy::needless_borrow)] | |||
|
|
|||
| //! [DataFusion] is an extensible query engine written in Rust that | |||
There was a problem hiding this comment.
I clarified this text and made it consistent with the other intros
| CSV, Parquet, JSON, and Avro, extensive customization, and a great | ||
| community. | ||
|
|
||
| DataFusion is an extensible query engine written in `Rust <http://rustlang.org>`_ that |
There was a problem hiding this 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/ 🤔
comphead
approved these changes
Sep 10, 2024
|
Thanks again @phillipleblanc and @comphead for reviewing this. Let's keep iterating on the docs as follow on PRs too. |
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Related to #12357
Rationale for this change
Inspired by @phillipleblanc's comment on #12357 (comment) 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:
Are these changes tested?
By CI
Are there any user-facing changes?
No functional change, only doc changes