Yasuke/moto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refer to correct black version (#5038)

Browse Source
This commit is contained in:
Iain Samuel McLean Elder 2022-04-20 00:18:28 +02:00 committed by GitHub
parent 10bd677cf2
commit ba7c852b64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -23,7 +23,7 @@ You should be able to run `make init` to install the dependencies and then `make
## Linting
Ensure that the correct version of black is installed - `black==19.10b0`. (Different versions of black will return different results.)
Ensure that the correct version of black is installed (see `requirements-dev.txt`). Different versions of black will return different results.
Run `make lint` to verify whether your code confirms to the guidelines.
Use `make format` to automatically format your code, if it does not conform to `black`'s rules.

3
Makefile
View File

@ -22,7 +22,8 @@ lint:
@echo "Running flake8..."
flake8 moto tests
@echo "Running black... "
@echo "(Make sure you have black-22.1.0 installed, as other versions will produce different results)"
$(eval black_version := $(shell grep -oP "(?<=black==).*" requirements-dev.txt))
@echo "(Make sure you have black-$(black_version) installed, as other versions will produce different results)"
black --check moto/ tests/
@echo "Running pylint..."
pylint -j 0 moto tests

3
docs/docs/contributing/faq.rst
View File

@ -16,7 +16,8 @@ When running the linter...
Why does black give different results?
****************************************
Different versions of black produce different results.
To ensure that our CI passes, please format the code using :bash:`black==19.10b0`.
The CI system uses the version set in `requirements-dev.txt`.
To ensure that our CI passes, please format the code using the same version.
When running a test...
#########################