X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/6316e293ac30a2837ec20eba289fd28a2a18cf89..8cf6bdb5b736fad127412377a72648c8cd3d044d:/README.md diff --git a/README.md b/README.md index 3558254..d5c88f4 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,16 @@ original. This slows it down. If you're feeling confident, use ``--fast``. +## Installation + +*Black* can be installed by running `pip install black`. It requires +Python 3.6.0+ to run but you can reformat Python 2 code with it, too. +*Black* is able to parse all of the new syntax supported on Python 3.6 +but also *effectively all* the Python 2 syntax at the same time. + + ## Usage -*Black* can be installed by running `pip install black`. ``` black [OPTIONS] [SRC]... @@ -262,27 +269,6 @@ Use the badge in your project's README.md: Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) - -## Tests - -Just run: - -``` -python setup.py test -``` - -## This tool requires Python 3.6.0+ to run - -But you can reformat Python 2 code with it, too. *Black* is able to parse -all of the new syntax supported on Python 3.6 but also *effectively all* -the Python 2 syntax at the same time. - -By making the code exclusively Python 3.6+, I'm able to focus on the -quality of the formatting and re-use all the nice features of the new -releases (check out [pathlib](https://docs.python.org/3/library/pathlib.html) or -f-strings) instead of wasting cycles on Unicode compatibility, and so on. - - ## License MIT @@ -308,9 +294,14 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.3a4 (unreleased) +* `# fmt: off` and `# fmt: on` are implemented (#5) + * automatic detection of deprecated Python 2 forms of print statements and exec statements in the formatted file (#49) +* use proper spaces for complex expressions in default values of typed + function arguments (#60) + * only return exit code 1 when --check is used (#50) * don't remove single trailing commas from square bracket indexing @@ -321,6 +312,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * omit extra space in kwarg unpacking if it's the first argument (#46) +* omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute) + (#68) + ### 18.3a3 @@ -394,3 +388,6 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Authors Glued together by [Łukasz Langa](mailto:lukasz@langa.pl). + +[Model T logo](https://thenounproject.com/term/model-t/16785/) by Alex +Valdivia from the Noun Project.