X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/12826f3c1e2ad75051d52cd2a81718a0349cc3db..6d8b90167b00707c5524f993933e33ddbd5a90f6:/README.md?ds=inline diff --git a/README.md b/README.md index d935b11..c39c7d5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@

Build Status +Actions Status Documentation Status Coverage Status License: MIT @@ -162,7 +163,7 @@ statement per line. If this fits the allotted line length, great. j = [1, 2, - 3, + 3 ] # out: @@ -284,6 +285,14 @@ curious about the reasoning behind B950, explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you overdo it by a few km/h". +**If you're looking for a minimal, black-compatible flake8 configuration:** + +```ini +[flake8] +max-line-length = 88 +extend-ignore = E203 +``` + ### Empty lines _Black_ avoids spurious vertical whitespace. This is in the spirit of PEP 8 which says @@ -733,9 +742,9 @@ nnoremap :Black ``` **How to get Vim with Python 3.6?** On Ubuntu 17.10 Vim comes with Python 3.6 by -default. On macOS with Homebrew run: `brew install vim --with-python3`. When building -Vim from source, use: `./configure --enable-python3interp=yes`. There's many guides -online how to do this. +default. On macOS with Homebrew run: `brew install vim`. When building Vim from source, +use: `./configure --enable-python3interp=yes`. There's many guides online how to do +this. ### Visual Studio Code @@ -772,6 +781,10 @@ hook global WinSetOption filetype=python %{ } ``` +### Thonny + +Use [Thonny-black-code-format](https://github.com/Franccisco/thonny-black-code-format). + ### Other editors Other editors will require external contributions. @@ -838,9 +851,6 @@ which if present, should have the value `1`, otherwise the request is rejected w The headers controlling how code is formatted are: -If any of these headers are set to invalid values, `blackd` returns a `HTTP 400` error -response, mentioning the name of the problematic header in the message body. - - `X-Line-Length`: corresponds to the `--line-length` command line flag. - `X-Skip-String-Normalization`: corresponds to the `--skip-string-normalization` command line flag. If present and its value is not the empty string, no string @@ -890,7 +900,9 @@ Then run `pre-commit install` and you're ready to go. Avoid using `args` in the hook. Instead, store necessary configuration in `pyproject.toml` so that editors and command-line usage of Black all behave consistently -for your project. See _Black_'s own [pyproject.toml](/pyproject.toml) for an example. +for your project. See _Black_'s own +[pyproject.toml](https://github.com/psf/black/blob/master/pyproject.toml) for an +example. If you're already using Python 3.7, switch the `language_version` accordingly. Finally, `stable` is a tag that is pinned to the latest release on PyPI. If you'd rather run on @@ -923,7 +935,7 @@ then write the above files to `.cache/black//`. The following notable open-source projects trust _Black_ with enforcing a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis, attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Pipenv, virtualenv), pandas, Pillow, every Datadog -Agent Integration. +Agent Integration, Home Assistant. Are we missing anyone? Let us know.