Fix typo (#916)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 9c83f2646894c72929b9cb60b146c1b50ada4211..dc93b37c6d75376cf5cee320c3d13652a4ad299f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -293,7 +293,7 @@ you are probably already using.  You'd do it like this:
 max-line-length = 80
 ...
 select = C,E,F,W,B,B950
-ignore = E501
+ignore = E501,W503,E203
 ```
 
 You'll find *Black*'s own .flake8 config file is configured like this.
@@ -844,6 +844,14 @@ Options:
   -h, --help                      Show this message and exit.
 ```
 
+There is no official blackd client tool (yet!). You can test that blackd is
+working using `curl`:
+
+```
+blackd --bind-port 9090 &  # or let blackd choose a port
+curl -s -XPOST "localhost:9090" -d "print('valid')"
+```
+
 ### Protocol
 
 `blackd` only accepts `POST` requests at the `/` path. The body of the request
@@ -902,7 +910,7 @@ 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`
+behave consistently for your project.  See *Black*'s own [pyproject.toml](/pyproject.toml)
 for an example.
 
 If you're already using Python 3.7, switch the `language_version`
@@ -925,12 +933,17 @@ is:
 `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
 as .pyi, and whether string normalization was omitted.
 
+To override the location of these files on macOS or Linux, set the environment variable
+`XDG_CACHE_HOME` to your preferred location. For example, if you want to put the cache in
+the directory you're running *Black* from, set `XDG_CACHE_HOME=.cache`. *Black* will then
+write the above files to `.cache/black/<version>/`.
 
 ## Used by
 
 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).
+attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Pipenv, virtualenv),
+every Datadog Agent Integration.
 
 Are we missing anyone?  Let us know.
 
@@ -996,31 +1009,42 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
-### 19.5b0
+### unreleased
+
+* added `black -c` as a way to format code passed from the command line
+  (#761)
+
+* --safe now works with Python 2 code (#840)
+
+* fixed grammar selection for Python 2-specific code (#765)
 
-* don't crash when run on a Windows machine with more than 61 cores (#838)
+* fixed feature detection for trailing commas in function definitions
+  and call sites (#763)
 
-* remove unnecessary parentheses around `yield` expressions (#834)
+* *Black* can now format async generators (#593)
 
-* add parentheses around long tuples in unpacking assignments (#832)
+* *Black* no longer crashes on Windows machines with more than 61 cores
+  (#838)
 
-* don't produce invalid code for `from` ... `import` blocks with comments
+* *Black* no longer crashes on standalone comments prepended with
+  a backslash (#767)
+
+* *Black* no longer crashes on `from` ... `import` blocks with comments
   (#829)
 
-* fix grammar selection (#765)
+* removed unnecessary parentheses around `yield` expressions (#834)
 
-* fix feature detection for trailing commas in function definitions and
-  call sites (#763)
+* added parentheses around long tuples in unpacking assignments (#832)
 
-* add `black -c` as a way to format code passed from the command line (#761)
+* fixed bug that led *Black* format some code with a line length target
+  of 1 (#762)
 
-* fix bug that led *Black* format some code with a line length target of 1
-  (#762)
+* *Black* no longer introduces quotes in f-string subexpressions on string
+  boundaries (#863)
 
-* --safe now works with Python 2 code (#840)
+* if *Black* puts parenthesis around a single expression, it moves comments
+  to the wrapped expression instead of after the brackets (#872)
 
-* *Black* no longer crashes on standalone comments prepended with
-  a backslash (#767)
 
 ### 19.3b0
 
@@ -1048,6 +1072,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * `blackd` now supports CORS (#622)
 
+
 ### 18.9b0
 
 * numeric literals are now formatted by *Black* (#452, #461, #464, #469):