diff options
| author | Laurent Peuch <cortex@worlddomination.be> | 2020-04-01 16:11:04 +0200 |
|---|---|---|
| committer | Laurent Peuch <cortex@worlddomination.be> | 2020-04-01 16:11:04 +0200 |
| commit | 32cd73810056594f55eff0ffafebbdeb50c7a860 (patch) | |
| tree | 0289a794bb9398b5ee858b98a202496fbc84ac40 | |
| parent | 8a910e9cb137ae04e9ad570adc46fa7104a5d9ab (diff) | |
| download | logilab-common-32cd73810056594f55eff0ffafebbdeb50c7a860.tar.gz | |
[README] add instruction on how to use and integrate black
Taken from yams taken from nemo
| -rw-r--r-- | .hgrc | 3 | ||||
| -rw-r--r-- | README.rst | 11 |
2 files changed, 14 insertions, 0 deletions
@@ -0,0 +1,3 @@ +[hooks] +precommit.black = tox -e black-run +pre-amend.black = tox -e black-run @@ -64,6 +64,17 @@ Then build the doc :: It's now available under `doc/_build/html/` +Code style +---------- + +The python code is verified against *flake8* and formatted with *black*. + +* You can run `tox -e black` to check that the files are well formatted. +* You can run `tox -e black-run` to format them if needed. +* You can include the `.hgrc` to your own `.hgrc` to automatically run black + before each commit/amend. This can be done by writing `%include ../.hgrc` at + the end of your `.hgrc`. + Comments, support, bug reports ------------------------------ |