Wordsmith project description #12778
Conversation
github-actions
bot
added
the
documentation
|
@alamb FYI |
There was a problem hiding this comment.
Thank you @matthewmturner -- I think this is an improvement 🙏
I have a suggestion for some additional improvements for your consideration
Co-authored-by: Andrew Lamb <[email protected]>
README.md
Outdated
| The DataFusion project provides libraries and binaries for data system | ||
| developers and end users such as data engineers and analysts. This repository | ||
| contains libraries for system developers. The following related projects work | ||
| out of the box and target end users. |
There was a problem hiding this comment.
The DataFrame API that this project ships, for whom it is? (mentioned 13 lines below)
Also, "The target audience for the DataFusion crates in this repository are developers" (9 lines below) sounds like a repetition now.
There was a problem hiding this comment.
The DataFrame API that this project ships, for whom it is? (mentioned 13 lines below)
It is a good question -- I think @timsaucer and @Omega359 uses the Rust DataFrame library as is.
There was a problem hiding this comment.
I do use the dataframe api almost exclusively. I say almost because I do allow sql expressions in my library which are converted to Expr's in DF and used via the dataframe api.
There was a problem hiding this comment.
I do use the DataFrame API exclusively, but I work almost entirely via datafusion-python.
|
I took the liberty of incorporating @findepi 's comments and updating the main docs page too and pushing an update to this PR |
| "Out of the box," | ||
| DataFusion offers [SQL] and [`Dataframe`] APIs, excellent [performance], |
There was a problem hiding this comment.
nit: Will this render with a linebreak after "Out of the box,"?
There was a problem hiding this comment.
I don't believe it will. Markdown is a bit ambiguous on this and different impl's handle this differently however most either will force a newline in rendered view if the line ends with two spaces (now that is a horrible pattern) or a back slash. This comment editor is an example of something that does put text on a newline
when a line break is encountered.
|
🚀 |
Which issue does this PR close?
Closes #.
Follow on to #12666
Rationale for this change
Improve project description to make it clear there are first class projects targeting end users.
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?