Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rust docs don't note when the parquet feature is needed #15291

Open
nk9 opened this issue Mar 26, 2024 · 1 comment
Open

Rust docs don't note when the parquet feature is needed #15291

nk9 opened this issue Mar 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@nk9
Copy link

nk9 commented Mar 26, 2024

Description

The Quickstart provides code which doesn't work out of the box after installing just the polars crate. You have to install the parquet and lazy features as well. However, the Quickstart docs don't mention this.

Also, the scan_parquet function also requies the parquet feature, but this is not indicated either. There are other feature requirements listed on that page, which would lead one to think that all feature requirements were called out, but this is not the case.

I think the feature requirement should be mentioned in both cases.

Link

https://docs.rs/polars/latest/polars/prelude/struct.LazyFrame.html#method.scan_parquet

@nk9 nk9 added the documentation Improvements or additions to documentation label Mar 26, 2024
@nk9
Copy link
Author

nk9 commented Jun 23, 2024

The Quickstart does say "We recommend to build your queries directly with polars-lazy." But… what does that mean? Are beginning users supposed to cargo add polars_lazy? What's the difference between that and polars with the lazy feature enabled? Does the sentence mean that users are recommended to call df.lazy().do_stuff()? Maybe both?

For beginners, this wording and link are pretty confusing. They've installed polars and gone to look at how to use it… and now they're being pointed at a different crate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant