docs: rewrite readme #8524
Merged
docs: rewrite readme #8524
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
|
probably worth going here to review: https://github.com/lostmygithubaccount/ibis/tree/readme |
word wrap some lines separate two points clarify point further python unwrap lines consistency wording
lostmygithubaccount
force-pushed
the
readme
branch
from
cd2edef
to
dd1a0d9
Compare
chiphuyen
reviewed
Mar 3, 2024
README.md
Outdated
| - [SQLite](https://ibis-project.org/backends/sqlite/) | ||
| - [Snowflake](https://ibis-project.org/backends/snowflake) (experimental) | ||
| - [Trino](https://ibis-project.org/backends/trino/) (experimental) | ||
| - Fast local dataframes with the default DuckDB backend |
There was a problem hiding this comment.
is it important to users that DuckDB is the default backend?
There was a problem hiding this comment.
maybe? I'm open to changing it, but I think this serves a few purposes:
- DuckDB hype: DuckDB is awesome, people love it, and Ibis provides a Pythonic dataframe on top by default
- explain the speed -- instead of wondering how Ibis can be so fast (did it implement its own engine?) a user can realize it's from DuckDB
- hint at portability/decoupling from API from engine -- if a user grasps that the Ibis API compiles down to DuckDB SQL, they can hopefully grasp how other backends work
cpcloud
requested changes
Mar 3, 2024
cpcloud
reviewed
Mar 3, 2024
cpcloud
approved these changes
Mar 4, 2024
|
merging as an improvement, can make further improvements later |
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.
Description of changes
opening for discussion/feedback. this:
we should also IMO update the GitHub description to "the portable Python dataframe library" -- the "flexibility of Python with the scale and performance of modern SQL" is in the REAMDE now
feedback welcome
Issues closed
closes #8436
cc: @chiphuyen @zhenzhongxu @ianmcook for feedback (in addition to the Ibis team who will see this PR anyway)