Skip to content

Commit cb952d3

Browse files
committed
docs(developing): Use ruff format
1 parent 7e32493 commit cb952d3

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

docs/developing.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -54,86 +54,84 @@ Rebuild docs and run server via one terminal: `make dev_docs` (requires above, a
5454

5555
## Linting
5656

57-
### black
57+
### ruff
5858

59-
[black] is used for formatting.
59+
The project uses [ruff] to handles formatting, sorting imports and linting.
6060

6161
````{tab} Command
6262
6363
poetry:
6464
6565
```console
66-
$ poetry run black .
66+
$ poetry run ruff
6767
```
6868
6969
If you setup manually:
7070
7171
```console
72-
$ black .
72+
$ ruff .
7373
```
7474
7575
````
7676

7777
````{tab} make
7878
7979
```console
80-
$ make black
80+
$ make ruff
8181
```
8282
8383
````
8484

85-
In the future, `ruff` (below) may replace black as formatter.
85+
````{tab} Watch
8686
87-
### ruff
87+
```console
88+
$ make watch_ruff
89+
```
8890
89-
The project uses [ruff] to handles formatting, sorting imports and linting.
91+
requires [`entr(1)`].
9092
91-
````{tab} Command
93+
````
94+
95+
````{tab} Fix files
9296
9397
poetry:
9498
9599
```console
96-
$ poetry run ruff
100+
$ poetry run ruff . --fix
97101
```
98102
99103
If you setup manually:
100104
101105
```console
102-
$ ruff .
106+
$ ruff . --fix
103107
```
104108
105109
````
106110

107-
````{tab} make
111+
#### ruff format
108112

109-
```console
110-
$ make ruff
111-
```
113+
[ruff format] is used for formatting.
112114

113-
````
115+
````{tab} Command
114116
115-
````{tab} Watch
117+
poetry:
116118
117119
```console
118-
$ make watch_ruff
120+
$ poetry run ruff format .
119121
```
120122
121-
requires [`entr(1)`].
122-
123-
````
124-
125-
````{tab} Fix files
126-
127-
poetry:
123+
If you setup manually:
128124
129125
```console
130-
$ poetry run ruff . --fix
126+
$ ruff format .
131127
```
132128
133-
If you setup manually:
129+
````
130+
131+
````{tab} make
134132
135133
```console
136-
$ ruff . --fix
134+
$ make ruff_format
137135
```
138136
139137
````
@@ -236,6 +234,6 @@ Update `__version__` in `__about__.py` and `pyproject.toml`::
236234
[poetry]: https://python-poetry.org/
237235
[entr(1)]: http://eradman.com/entrproject/
238236
[`entr(1)`]: http://eradman.com/entrproject/
239-
[black]: https://github.com/psf/black
237+
[ruff format]: https://docs.astral.sh/ruff/formatter/
240238
[ruff]: https://ruff.rs
241239
[mypy]: http://mypy-lang.org/

0 commit comments

Comments
 (0)