psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mention isort import ordering in documentation.

Browse source
This commit is contained in:
Dan Helfman 2019-05-16 12:06:55 -07:00
parent 9417359da3
commit 8b41e58e1f
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/how-to/develop-on-borgmatic.md
View file

@ -62,6 +62,14 @@ following:
tox -e black tox -e black
``` ```
And if you get a complaint from the
[isort](https://github.com/timothycrosley/isort) Python import orderer, you
can ask isort to order your imports for you:
```bash
tox -e isort
```
### End-to-end tests ### End-to-end tests
borgmatic additionally includes some end-to-end tests that integration test borgmatic additionally includes some end-to-end tests that integration test
@ -87,9 +95,10 @@ the following deviations from it:
indentation with an opening delimeter. indentation with an opening delimeter.
borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
formatter and [Flake8](http://flake8.pycqa.org/en/latest/) code checker, so formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
the [isort](https://github.com/timothycrosley/isort) import orderer, so
certain code style requirements will be enforced when running automated tests. certain code style requirements will be enforced when running automated tests.
See the Black and Flake8 documentation for more information. See the Black, Flake8, and isort documentation for more information.
## Continuous integration ## Continuous integration