From e592b160adba3fada2093a735b9b0f6d77767647 Mon Sep 17 00:00:00 2001 From: Alexander Beedie Date: Tue, 31 Oct 2023 20:16:35 +0400 Subject: [PATCH] doc: fix incorrect `filter` syntax (#12143) Co-authored-by: Stijn de Gooijer --- docs/development/contributing/index.md | 4 ++-- docs/src/python/user-guide/io/cloud-storage.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/development/contributing/index.md b/docs/development/contributing/index.md index a537a407b65d..db6c89f7735a 100644 --- a/docs/development/contributing/index.md +++ b/docs/development/contributing/index.md @@ -111,7 +111,7 @@ Create a new git branch from the `main` branch in your local repository, and sta The Rust code is located in the `crates` directory, while the Python codebase is located in the `py-polars` directory. Both directories contain a `Makefile` with helpful commands. Most notably: -- `make test` to run the test suite (see the [test suite docs](https://github.com/pola-rs/polars/blob/main/py-polars/tests/README.md) for more info) +- `make test` to run the test suite (see the [test suite docs](./test.md) for more info) - `make pre-commit` to run autoformatting and linting Note that your work cannot be merged if these checks fail! @@ -132,7 +132,7 @@ Please adhere to the following guidelines: - In the pull request description, [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to the issue you were working on. - Add any relevant information to the description that you think may help the maintainers review your code. - Make sure your branch is [rebased](https://docs.github.com/en/get-started/using-git/about-git-rebase) against the latest version of the `main` branch. -- Make sure all [GitHub Actions checks](https://github.com/pola-rs/polars/blob/main/.github/workflows/README.md) pass. +- Make sure all [GitHub Actions checks](./ci.md) pass. After you have opened your pull request, a maintainer will review it and possibly leave some comments. Once all issues are resolved, the maintainer will merge your pull request, and your work will be part of the next Polars release! diff --git a/docs/src/python/user-guide/io/cloud-storage.py b/docs/src/python/user-guide/io/cloud-storage.py index 0f968e15f97b..15e456cfe61d 100644 --- a/docs/src/python/user-guide/io/cloud-storage.py +++ b/docs/src/python/user-guide/io/cloud-storage.py @@ -36,7 +36,7 @@ dset = ds.dataset("s3://my-partitioned-folder/", format="parquet") ( pl.scan_pyarrow_dataset(dset) - .filter("foo" == "a") + .filter(pl.col("foo") == "a") .select(["foo", "bar"]) .collect() )