Skip to content

Commit

Permalink
docs(python): Hint about ruff setting in VSCode (pola-rs#13421)
Browse files Browse the repository at this point in the history
Co-authored-by: Stijn de Gooijer <[email protected]>
  • Loading branch information
deanm0000 and stinodego authored Jan 10, 2024
1 parent 683d34d commit f4401fb
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/development/contributing/ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ This page contains some recommendations for configuring popular IDEs.

## Visual Studio Code

The following extensions are recommended.
Make sure to configure VSCode to use the virtual environment created by the Makefile.

In addition, the extensions below are recommended.

### rust-analyzer

Expand All @@ -23,6 +25,14 @@ For it to work well for the Polars code base, add the following settings to your

The Ruff extension will help you conform to the formatting requirements of the Python code.
We use both the Ruff linter and formatter.
It is recommended to configure the extension to use the Ruff installed in your environment.
This will make it use the correct Ruff version and configuration.

```json
{
"ruff.importStrategy": "fromEnvironment",
}
```

## PyCharm / RustRover / CLion

Expand Down

0 comments on commit f4401fb

Please sign in to comment.