From f86ca8c54576a3c45f031bc1c55fa07dd19d7b31 Mon Sep 17 00:00:00 2001 From: Dorian Turba <froggit.commit.z3jqj@simplelogin.com> Date: Sat, 8 Jul 2023 12:00:43 +0200 Subject: [PATCH] update README.md --- python/code_quality/black/README.md | 9 ++++++--- python/code_quality/flake8/README.md | 4 ++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/python/code_quality/black/README.md b/python/code_quality/black/README.md index f8c179c..b4a80e8 100644 --- a/python/code_quality/black/README.md +++ b/python/code_quality/black/README.md @@ -21,10 +21,13 @@ line-length = 100 ## How to use it -2. Include template in your CI/CD conf (see quick use above) -3. Customize the template if it's relevant +1. Configure the black section of `pyproject.toml` in your repository's with your desired rules. +2. Include the Black template in your CI/CD configuration (see quick use above). +3. Customize the template if it's relevant. -## Add <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> cartouche to your project README.md +## Add a <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> badge to your project README.md + +To display the use of Black in your project, you can add the following badge to your README.md: ```markdown <a href="https://github.com/psf/black"> diff --git a/python/code_quality/flake8/README.md b/python/code_quality/flake8/README.md index c6cc96a..d6db1e1 100644 --- a/python/code_quality/flake8/README.md +++ b/python/code_quality/flake8/README.md @@ -19,8 +19,8 @@ max-complexity = 10 max-line-length = 100 ``` -This example ignores certain errors, sets the maximum line length to 100 characters, excludes the -tests directory, and sets the maximum McCabe complexity to 10. +This example sets the maximum line length to 100 characters, excludes the tests directory, and sets +the maximum complexity to 10. ## How to use it -- GitLab