]> git.madduck.net Git - etc/vim.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Compress the logos better
[etc/vim.git] / README.md
index 35582545e2c6fe53cc4e2ca5f95cafd3ee1fac91..d5c88f40d92ff03068693d83615dbace8bbd0db0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,9 +34,16 @@ original.  This slows it down.  If you're feeling confident, use
 ``--fast``.
 
 
 ``--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
 
 ## Usage
 
-*Black* can be installed by running `pip install black`.
 
 ```
 black [OPTIONS] [SRC]...
 
 ```
 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)
 
 
 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
 ## License
 
 MIT
@@ -308,9 +294,14 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ### 18.3a4 (unreleased)
 
 
 ### 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)
 
 * 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
 * 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 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
 
 
 ### 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).
 ## 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.