X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/dd4477b70120bf736144c38ec50144253f34dce2..642f240253324b7f342529b429979abc5227e66d:/README.md diff --git a/README.md b/README.md index f587744..57f3ac2 100644 --- a/README.md +++ b/README.md @@ -78,14 +78,16 @@ Options: used). -### NOTE: This is an early pre-release +### NOTE: This is a beta product -*Black* can already successfully format itself and the standard library. +*Black* is already successfully used by several projects, small and big. It also sports a decent test suite. However, it is still very new. Things will probably be wonky for a while. This is made explicit by the -"Alpha" trove classifier, as well as by the "a" in the version number. +"Beta" trove classifier, as well as by the "b" in the version number. What this means for you is that **until the formatter becomes stable, -you should expect some formatting to change in the future**. +you should expect some formatting to change in the future**. That being +said, no drastic stylistic changes are planned, mostly responses to bug +reports. Also, as a temporary safety measure, *Black* will check that the reformatted code still produces a valid AST that is equivalent to the @@ -178,9 +180,9 @@ example above). If a data structure literal (tuple, list, set, dict) or a line of "from" imports cannot fit in the allotted length, it's always split into one -per line. This minimizes diffs as well as enables readers of code to -find which commit introduced a particular entry. This also makes -*Black* compatible with [isort](https://pypi.org/p/isort/). Use +element per line. This minimizes diffs as well as enables readers of +code to find which commit introduced a particular entry. This also +makes *Black* compatible with [isort](https://pypi.org/p/isort/). Use `multi_line_output=3`, `include_trailing_comma=True`, `force_grid_wrap=0`, and `line_length=88` in your isort config. @@ -628,7 +630,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log -### 18.5a0 (unreleased) +### 18.5b0 * call chains are now formatted according to the [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface)