Fix unstable formatting with some `# type: ignore`s (#1113)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 380965824e3411e2b63ed1babcb2e091e09c7670..82f2df16cfe6ef7057e2fb65665f8a8d318d037a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
 <a href="https://coveralls.io/github/psf/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=master"></a>
 <a href="https://github.com/psf/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
-<a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://black.readthedocs.io/en/stable/_static/pypi.svg"></a>
+<a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 </p>
@@ -284,6 +284,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
@@ -849,6 +857,8 @@ The headers controlling how code is formatted are:
   a set of comma-separated Python versions, optionally prefixed with `py`. For example,
   to request code that is compatible with Python 3.5 and 3.6, set the header to
   `py3.5,py3.6`.
+- `X-Diff`: corresponds to the `--diff` command line flag. If present, a diff of the
+  formats will be output.
 
 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.
@@ -1001,6 +1011,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 - fixed feature detection for trailing commas in function definitions and call sites
   (#763)
 
+- `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
+  code now behave correctly (#1005)
+
 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
 
 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
@@ -1034,6 +1047,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 - `blackd` now returns the version of _Black_ in the response headers (#1013)
 
+- `blackd` can now output the diff of formats on source code when the `X-Diff` header is
+  provided (#969)
+
 ### 19.3b0
 
 - new option `--target-version` to control which Python versions _Black_-formatted code
@@ -1430,25 +1446,67 @@ Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
 
 Multiple contributions by:
 
+- [Abdur-Rahmaan Janhangeer](mailto:cryptolabour@gmail.com)
+- [Adam Johnson](mailto:me@adamj.eu)
+- [Alexander Huynh](mailto:github@grande.coffee)
+- [Andrew Thorp](mailto:andrew.thorp.dev@gmail.com)
+- [Andrey](mailto:dyuuus@yandex.ru)
+- [Andy Freeland](mailto:andy@andyfreeland.net)
 - [Anthony Sottile](mailto:asottile@umich.edu)
+- [Arjaan Buijk](mailto:arjaan.buijk@gmail.com)
 - [Artem Malyshev](mailto:proofit404@gmail.com)
+- [Asger Hautop Drewsen](mailto:asgerdrewsen@gmail.com)
+- [Augie Fackler](mailto:raf@durin42.com)
+- [Aviskar KC](mailto:aviskarkc10@gmail.com)
 - [Benjamin Woodruff](mailto:github@benjam.info)
+- [Brandt Bucher](mailto:brandtbucher@gmail.com)
+- Charles Reid
 - [Christian Heimes](mailto:christian@python.org)
+- [Chuck Wooters](mailto:chuck.wooters@microsoft.com)
+- [Daniel Hahler](mailto:github@thequod.de)
 - [Daniel M. Capella](mailto:polycitizen@gmail.com)
+- Daniele Esposti
+- dylanjblack
 - [Eli Treuherz](mailto:eli@treuherz.com)
+- [Florent Thiery](mailto:fthiery@gmail.com)
 - hauntsaninja
 - Hugo van Kemenade
 - [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 - [Jason Fried](mailto:me@jasonfried.info)
+- [jgirardet](mailto:ijkl@netc.fr)
+- [Joe Antonakakis](mailto:jma353@cornell.edu)
+- [Jon Dufresne](mailto:jon.dufresne@gmail.com)
 - [Jonas Obrist](mailto:ojiidotch@gmail.com)
+- [Josh Bode](mailto:joshbode@fastmail.com)
+- [Juan Luis Cano Rodríguez](mailto:hello@juanlu.space)
+- [Katie McLaughlin](mailto:katie@glasnt.com)
+- Lawrence Chan
+- [Linus Groh](mailto:mail@linusgroh.de)
 - [Luka Sterbic](mailto:luka.sterbic@gmail.com)
+- Mariatta
+- [Matt VanEseltine](mailto:vaneseltine@gmail.com)
+- [Michael Flaxman](mailto:michael.flaxman@gmail.com)
+- [Michael J. Sullivan](mailto:sully@msully.net)
+- [Michael McClimon](mailto:michael@mcclimon.org)
 - [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
+- [Mike](mailto:roshi@fedoraproject.org)
+- [Min ho Kim](mailto:minho42@gmail.com)
 - [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
 - [Neraste](mailto:neraste.herr10@gmail.com)
+- [Ofek Lev](mailto:ofekmeister@gmail.com)
 - [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
+- [Pablo Galindo](mailto:Pablogsal@gmail.com)
 - [Peter Bengtsson](mailto:mail@peterbe.com)
+- pmacosta
+- [Rishikesh Jha](mailto:rishijha424@gmail.com)
 - [Stavros Korokithakis](mailto:hi@stavros.io)
+- [Stephen Rosen](mailto:sirosen@globus.org)
 - [Sunil Kapil](mailto:snlkapil@gmail.com)
+- [Thom Lu](mailto:thomas.c.lu@gmail.com)
+- [Tom Christie](mailto:tom@tomchristie.com)
+- [Tzu-ping Chung](mailto:uranusjr@gmail.com)
 - [Utsav Shah](mailto:ukshah2@illinois.edu)
+- vezeli
 - [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
-- [Chuck Wooters](mailto:chuck.wooters@microsoft.com)
+- [Yngve Høiseth](mailto:yngve@hoiseth.net)
+- [Yurii Karabas](mailto:1998uriyyo@gmail.com)