Skip to content

Commit bc59492

Browse files
authored
revert back 'black' to 'ruff'
1 parent 1dc6884 commit bc59492

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/explanations/decisions/0008-use-tox.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ against the changes you are about to commit.
2626
There are a number of things that CI needs to run:
2727

2828
- pytest
29-
- ruff
29+
- black
3030
- mypy
3131
- flake8
3232
- isort
@@ -44,7 +44,7 @@ under pytest that had a plugin, and isort under flake8:
4444
4545
subgraph cluster_0 {
4646
label = "pytest"
47-
"pytest-ruff"
47+
"pytest-black"
4848
"pytest-mypy"
4949
subgraph cluster_1 {
5050
label = "pytest-flake8"
@@ -68,15 +68,15 @@ To address this, the tree was rearranged:
6868
node [fontname="Lato" fontsize=10 shape=box style=filled fillcolor="#8BC4E9"]
6969
7070
pytest
71-
ruff
71+
black
7272
mypy
7373
subgraph cluster_1 {
7474
label = "flake8"
7575
"flake8-isort"
7676
}
7777
```
7878

79-
If using VSCode, this will still run ruff, flake8 and mypy on file save, but
79+
If using VSCode, this will still run black, flake8 and mypy on file save, but
8080
for those using other editors and for CI another solution was needed. Enter
8181
[pre-commit](https://pre-commit.com/). This allows hooks to be run at `git
8282
commit` time on just the files that have changed, as well as on all tracked
@@ -113,7 +113,7 @@ The graph now looks like:
113113
"sphinx-build"
114114
subgraph cluster_1 {
115115
label = "pre-commit"
116-
ruff
116+
black
117117
subgraph cluster_2 {
118118
label = "flake8"
119119
"flake8-isort"
@@ -124,11 +124,11 @@ The graph now looks like:
124124

125125
Now the workflow looks like this:
126126

127-
- Save file, VSCode runs ruff, flake8 and mypy on it
127+
- Save file, VSCode runs black, flake8 and mypy on it
128128
- Run 'tox -p' and fix issues until it succeeds
129-
- Commit files and pre-commit runs ruff and flake8 on them (if the
129+
- Commit files and pre-commit runs black and flake8 on them (if the
130130
developer had not run tox then this catches some of the most common issues)
131-
- Push to remote and CI runs ruff, flake8, mypy once on all files
131+
- Push to remote and CI runs black, flake8, mypy once on all files
132132
(using tox), then pytest multiple times in a test matrix
133133

134134
## Consequences

0 commit comments

Comments
 (0)