You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PR #592 introduces changes to the documentation alone (presented in issue #589), leading to the replacement of the sections on Black, isort and Flake8 previously used for linting and formatting code, in favour of a paragraph on Ruff, which therefore becomes the unique tool recommended for these actions.
Some other parts of the documentation (minimum configs for .pre-commit-config.yaml file, other references to the tools replaced by Ruff) have also been updated accordingly.
The next step is to implement the recommendations set out in the documentation, and migrate the project to Ruff.
💡 Steps for implementing the feature
To do this, the various configurations relating to Black, isort and Flake8 must be removed and a setup for Ruff must be introduced.
The aim is to use Ruff to implement the same linting and formatting rules that were previously provided by the 3 former tools.
As mentioned in #589, please note, however, that blacken-docs, used for formatting Python code blocks in documentation files, cannot currently be replaced by Ruff, which does not support formatting/linting of embedded code (particularly in .rst or .md files, see astral-sh/ruff#8237). Similarly, blacken-docs does not support the Ruff formatter as an alternative for Black (see adamchainz/blacken-docs#352).
As a result, this tool is retained and will continue to be used as part of the .pre-commit-config.yaml file (see about the Ruff pre-commit hook astral-sh/ruff-pre-commit#55) for this project despite its dependence on Black.
🔗 Useful links and references
The following PRs have been used as a reference for migrating a project to Ruff:
📝 Description of the feature
PR #592 introduces changes to the documentation alone (presented in issue #589), leading to the replacement of the sections on Black, isort and Flake8 previously used for linting and formatting code, in favour of a paragraph on Ruff, which therefore becomes the unique tool recommended for these actions.
Some other parts of the documentation (minimum configs for .pre-commit-config.yaml file, other references to the tools replaced by Ruff) have also been updated accordingly.
The next step is to implement the recommendations set out in the documentation, and migrate the project to Ruff.
💡 Steps for implementing the feature
To do this, the various configurations relating to Black, isort and Flake8 must be removed and a setup for Ruff must be introduced.
The aim is to use Ruff to implement the same linting and formatting rules that were previously provided by the 3 former tools.
As mentioned in #589, please note, however, that blacken-docs, used for formatting Python code blocks in documentation files, cannot currently be replaced by Ruff, which does not support formatting/linting of embedded code (particularly in .rst or .md files, see astral-sh/ruff#8237). Similarly, blacken-docs does not support the Ruff formatter as an alternative for Black (see adamchainz/blacken-docs#352).
As a result, this tool is retained and will continue to be used as part of the .pre-commit-config.yaml file (see about the Ruff pre-commit hook astral-sh/ruff-pre-commit#55) for this project despite its dependence on Black.
🔗 Useful links and references
The following PRs have been used as a reference for migrating a project to Ruff:
The text was updated successfully, but these errors were encountered: