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.

Sign up for GitHub

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

Jump to bottom

Remove mention of black which has been long replaced by ruff #4146

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Remove mention of black which has been long replaced by ruff #4146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/source/starters/new_project_tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To skip this step in future use --tools
To find out more: https://docs.kedro.org/en/stable/starters/new_project_tools.html

Tools
1) Lint: Basic linting with Black and Ruff
1) Lint: Basic linting with Ruff
2) Test: Basic testing with pytest
3) Log: Additional, environment-specific logging options
4) Docs: A Sphinx documentation setup
Expand All @@ -65,8 +65,7 @@ A list of available tools can also be accessed by running `kedro new --help`

Tools

1) Linting: Provides a basic linting setup with Black
and Ruff
1) Linting: Provides a basic linting setup with Ruff

2) Testing: Provides basic testing setup with pytest

Expand Down Expand Up @@ -165,7 +164,7 @@ The available tools include: [linting](#linting), [testing](#testing), [custom l

### Linting

The Kedro linting tool introduces [`black`](https://black.readthedocs.io/en/stable/index.html) and [`ruff`](https://docs.astral.sh/ruff/) as dependencies in your new project's requirements. After project creation, make sure these are installed by running the following command from the project root:
The Kedro linting tool introduces [`ruff`](https://docs.astral.sh/ruff/) as dependency in your new project's requirements. After project creation, make sure these are installed by running the following command from the project root:

```bash
pip install -r requirements.txt
Expand All @@ -175,7 +174,6 @@ The linting tool will configure `ruff` with the following settings by default:
```toml
#pyproject.toml

[tool.ruff]
line-length = 88
show-fixes = true
select = [
Expand All @@ -187,7 +185,7 @@ select = [
"PL", # Pylint
"T201", # Print Statement
]
ignore = ["E501"] # Black takes care of line-too-long
ignore = ["E501"] # Ruff format takes care of line-too-long
```

With these installed, you can then make use of the following commands to format and lint your code:
Expand Down