docs(io): doc/ux improvements for read_parquet and friends #5423
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
ogrisel
reviewed
Feb 2, 2023
| 1. Note that the `ibis-framework` package is *not* the same as the `ibis` package in PyPI. These two libraries cannot coexist in the same Python environment, as they are both imported with the `ibis` module name. | ||
| 1. We suggest starting with the DuckDB backend. It's performant and fully featured. If you would like to use a different backend, all of the available options are listed below. | ||
|
|
||
| 2. Note that the `ibis-framework` package is *not* the same as the `ibis` package in PyPI. These two libraries cannot coexist in the same Python environment, as they are both imported with the `ibis` module name. | ||
|
|
||
| {% for mgr in ["conda", "mamba"] %} | ||
| === "{{ mgr }}" |
There was a problem hiding this comment.
Thanks for the quick PR!
Is it intentional that the conda-forge ibis-framework comes by default with the duckdb engine while the pypi does not? I had not realized this discrepancy existed when opening the issue.
There was a problem hiding this comment.
Not really, except that conda-forge doesn't have a notion of optional dependencies so we decided to make the default install a bit more convenient.
If we did this for pypi installs then duckdb (and a few other things, like sqlalchemy) would become required dependencies.
ogrisel
reviewed
Feb 2, 2023
gforsyth
force-pushed
the
gil/docs_ux_fixes
branch
2 times, most recently
from
9141d03
to
e63a2c8
Compare
ogrisel
approved these changes
Feb 2, 2023
xref ibis-project#5420 Default to `duckdb` in the install doc, fix the API doc of `default_backend`, and note that the `read_*` functions passthrough to the default backend. Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
gforsyth
force-pushed
the
gil/docs_ux_fixes
branch
from
b9bfcfa
to
44e3477
Compare
ogrisel
added a commit
to ogrisel/ibis
that referenced
this pull request
Feb 3, 2023
…backend Follow up on ibis-project#5423 xref ibis-project#5420 This also adds single quotes around bracketed pip install commands to make sure they work with zsh which is the default shell on macOS.
ogrisel
added a commit
to ogrisel/ibis
that referenced
this pull request
Feb 3, 2023
…backend Follow up on ibis-project#5423 xref ibis-project#5420 This also adds single quotes around bracketed pip install commands to make sure they work with zsh which is the default shell on macOS.
cpcloud
pushed a commit
to ogrisel/ibis
that referenced
this pull request
Feb 3, 2023
…backend Follow up on ibis-project#5423 xref ibis-project#5420 This also adds single quotes around bracketed pip install commands to make sure they work with zsh which is the default shell on macOS.
cpcloud
pushed a commit
to ogrisel/ibis
that referenced
this pull request
Feb 3, 2023
…backend Follow up on ibis-project#5423 xref ibis-project#5420 This also adds single quotes around bracketed pip install commands to make sure they work with zsh which is the default shell on macOS.
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.
xref #5420
Default to
duckdbin the install doc, fix the API doc ofdefault_backend, and note that theread_*functions passthrough tothe default backend.