From 7fce523cc861263c82aa0543ce0878eb1a010b74 Mon Sep 17 00:00:00 2001 From: Merel Theisen Date: Thu, 5 Sep 2024 15:40:12 +0100 Subject: [PATCH] Remove mention of black which has been long replaced by ruff Signed-off-by: Merel Theisen --- docs/source/starters/new_project_tools.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/source/starters/new_project_tools.md b/docs/source/starters/new_project_tools.md index ab43308ecb..c405200407 100644 --- a/docs/source/starters/new_project_tools.md +++ b/docs/source/starters/new_project_tools.md @@ -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 @@ -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 @@ -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 @@ -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 = [ @@ -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: