Link isort profile to Black code style isort mention (#2246)

[etc/vim.git] / CHANGES.md

diff --git a/CHANGES.md b/CHANGES.md
index 52c8016a257a3341e4014db194fa5c83edb722e2..603554cd8b7d9f417edaeec6644cdd44a3bca54a 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,29 +1,160 @@
-## Change Log
+# Change Log

 
 

-### Unreleased
+## Unreleased

 
 

-#### _Black_
+### _Black_
+
+- Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
+  `.gitignore` rules like `git` does) (#2225)
+- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
+
+### _Blackd_
+
+- Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
+  supported. (#2231)
+
+### Documentation
+
+- Fix typos discovered by codespell (#2228)
+- Fix Vim plugin installation instructions. (#2235)
+
+## 21.5b1
+
+### _Black_
+
+- Refactor `src/black/__init__.py` into many files (#2206)
+
+### Documentation
+
+- Replaced all remaining references to the
+  [`master`](https://github.com/psf/black/tree/main) branch with the
+  [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
+  the source code were also made. (#2210)
+- Sigificantly reorganized the documentation to make much more sense. Check them out by
+  heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
+  (#2174)
+
+## 21.5b0
+
+### _Black_
+
+- Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
+- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
+  being called but with no arguments (#2182)
+
+### _Black-Primer_
+
+- Add `--no-diff` to black-primer to suppress formatting changes (#2187)
+
+## 21.4b2
+
+### _Black_
+
+- Fix crash if the user configuration directory is inaccessible. (#2158)
+
+- Clarify
+  [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
+  in which _Black_ may change the AST (#2159)
+
+- Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
+  or on the command line. (#2170)
+
+### _Packaging_
+
+- Install `primer.json` (used by `black-primer` by default) with black. (#2154)
+
+## 21.4b1
+
+### _Black_
+
+- Fix crash on docstrings ending with "\\ ". (#2142)
+
+- Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
+
+- Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
+  in the name of the cache file. Without this fix, changes in these flags would not take
+  effect if the cache had already been populated. (#2131)
+
+- Don't remove necessary parentheses from assignment expression containing assert /
+  return statements. (#2143)
+
+### _Packaging_
+
+- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
+
+## 21.4b0
+
+### _Black_
+
+- Fixed a rare but annoying formatting instability created by the combination of
+  optional trailing commas inserted by `Black` and optional parentheses looking at
+  pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
+  duplicates. (#2126)
+
+- `Black` now processes one-line docstrings by stripping leading and trailing spaces,
+  and adding a padding space when needed to break up """". (#1740)
+
+- `Black` now cleans up leading non-breaking spaces in comments (#2092)

 
 - `Black` now respects `--skip-string-normalization` when normalizing multiline
   docstring quotes (#1637)
 
 
 - `Black` now respects `--skip-string-normalization` when normalizing multiline
   docstring quotes (#1637)
 

+- `Black` no longer removes all empty lines between non-function code and decorators
+  when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
+

 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
   in if/while statements (#1655)
 
 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
   in if/while statements (#1655)
 

+- Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
+  to split lines (#1824)
+

 - fixed a crash when PWD=/ on POSIX (#1631)
 
 - fixed a crash when PWD=/ on POSIX (#1631)
 

+- fixed "I/O operation on closed file" when using --diff (#1664)
+

 - Prevent coloured diff output being interleaved with multiple files (#1673)
 
 - Prevent coloured diff output being interleaved with multiple files (#1673)
 

-### 20.8b1
+- Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
+
+- Added parsing support for unparenthesized tuples and yield expressions in annotated
+  assignments (#1835)
+
+- added `--extend-exclude` argument (PR #2005)
+
+- speed up caching by avoiding pathlib (#1950)
+
+- `--diff` correctly indicates when a file doesn't end in a newline (#1662)
+
+- Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
+  (#1780)
+
+- Lines ending with `fmt: skip` will now be not formatted (#1800)
+
+- PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
+
+- PR #2053: Python 2 support is now optional, install with
+  `python3 -m pip install black[python2]` to maintain support.
+
+- Exclude `venv` directory by default (#1683)
+
+- Fixed "Black produced code that is not equivalent to the source" when formatting
+  Python 2 docstrings (#2037)
+
+### _Packaging_
+
+- Self-contained native _Black_ binaries are now provided for releases via GitHub
+  Releases (#1743)
+
+## 20.8b1

 
 

-#### _Packaging_
+### _Packaging_

 
 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
   older than 7.0
 
 
 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
   older than 7.0
 

-### 20.8b0
+## 20.8b0

 
 

-#### _Black_
+### _Black_

 
 - re-implemented support for explicit trailing commas: now it works consistently within
   any bracket pair, including nested structures (#1288 and duplicates)
 
 - re-implemented support for explicit trailing commas: now it works consistently within
   any bracket pair, including nested structures (#1288 and duplicates)


@@ -67,11 +198,11 @@
   this is an undocumented and unsupported feature, you lose Internet points for
   depending on it (#1609)
 
   this is an undocumented and unsupported feature, you lose Internet points for
   depending on it (#1609)
 

-#### Vim plugin
+### Vim plugin

 
 - prefer virtualenv packages over global packages (#1383)
 
 
 - prefer virtualenv packages over global packages (#1383)
 

-### 19.10b0
+## 19.10b0

 
 - added support for PEP 572 assignment expressions (#711)
 
 
 - added support for PEP 572 assignment expressions (#711)
 


@@ -130,7 +261,7 @@
 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
   provided (#969)
 
 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
   provided (#969)
 

-### 19.3b0
+## 19.3b0

 
 - new option `--target-version` to control which Python versions _Black_-formatted code
   should target (#618)
 
 - new option `--target-version` to control which Python versions _Black_-formatted code
   should target (#618)


@@ -155,7 +286,7 @@
 
 - `blackd` now supports CORS (#622)
 
 
 - `blackd` now supports CORS (#622)
 

-### 18.9b0
+## 18.9b0

 
 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
 
 
 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
 


@@ -170,7 +301,9 @@
 
   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
 
 
   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
 

-- added `blackd`, see [its documentation](#blackd) for more info (#349)
+- added `blackd`, see
+  [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
+  more info (#349)

 
 - adjacent string literals are now correctly split into multiple lines (#463)
 
 
 - adjacent string literals are now correctly split into multiple lines (#463)
 


@@ -197,11 +330,11 @@
 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
   be a bad idea (#415)
 
 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
   be a bad idea (#415)
 

-### 18.6b4
+## 18.6b4

 
 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
 
 
 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
 

-### 18.6b3
+## 18.6b3

 
 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
 
 
 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
 


@@ -229,7 +362,7 @@
 
 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
 
 
 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
 

-### 18.6b2
+## 18.6b2

 
 - added `--config` (#65)
 
 
 - added `--config` (#65)
 


@@ -243,13 +376,13 @@
 
 - fixed unnecessary slowdown in comment placement calculation on lines without comments
 
 
 - fixed unnecessary slowdown in comment placement calculation on lines without comments
 

-### 18.6b1
+## 18.6b1

 
 - hotfix: don't output human-facing information on stdout (#299)
 
 - hotfix: don't output cake emoji on non-zero return code (#300)
 
 
 - hotfix: don't output human-facing information on stdout (#299)
 
 - hotfix: don't output cake emoji on non-zero return code (#300)
 

-### 18.6b0
+## 18.6b0

 
 - added `--include` and `--exclude` (#270)
 
 
 - added `--include` and `--exclude` (#270)
 


@@ -267,7 +400,7 @@
 
 - _Black_ now preserves line endings when formatting a file in place (#258)
 
 
 - _Black_ now preserves line endings when formatting a file in place (#258)
 

-### 18.5b1
+## 18.5b1

 
 - added `--pyi` (#249)
 
 
 - added `--pyi` (#249)
 


@@ -296,7 +429,7 @@
 - fixed extra empty line between a function signature and an inner function or inner
   class (#196)
 
 - fixed extra empty line between a function signature and an inner function or inner
   class (#196)
 

-### 18.5b0
+## 18.5b0

 
 - call chains are now formatted according to the
   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
 
 - call chains are now formatted according to the
   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)


@@ -351,11 +484,11 @@
 
 - fixed crash when dead symlinks where encountered
 
 
 - fixed crash when dead symlinks where encountered
 

-### 18.4a4
+## 18.4a4

 
 - don't populate the cache on `--check` (#175)
 
 
 - don't populate the cache on `--check` (#175)
 

-### 18.4a3
+## 18.4a3

 
 - added a "cache"; files already reformatted that haven't changed on disk won't be
   reformatted again (#109)
 
 - added a "cache"; files already reformatted that haven't changed on disk won't be
   reformatted again (#109)


@@ -383,7 +516,7 @@
 
 - fixed missing splits of ternary expressions (#141)
 
 
 - fixed missing splits of ternary expressions (#141)
 

-### 18.4a2
+## 18.4a2

 
 - fixed parsing of unaligned standalone comments (#99, #112)
 
 
 - fixed parsing of unaligned standalone comments (#99, #112)
 


@@ -394,7 +527,7 @@
 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
   (#120)
 
 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
   (#120)
 

-### 18.4a1
+## 18.4a1

 
 - added `--quiet` (#78)
 
 
 - added `--quiet` (#78)
 


@@ -406,7 +539,7 @@
 
 - fixed removing backslash escapes from raw strings (#100, #105)
 
 
 - fixed removing backslash escapes from raw strings (#100, #105)
 

-### 18.4a0
+## 18.4a0

 
 - added `--diff` (#87)
 
 
 - added `--diff` (#87)
 


@@ -431,7 +564,7 @@
 - only allow up to two empty lines on module level and only single empty lines within
   functions (#74)
 
 - only allow up to two empty lines on module level and only single empty lines within
   functions (#74)
 

-### 18.3a4
+## 18.3a4

 
 - `# fmt: off` and `# fmt: on` are implemented (#5)
 
 
 - `# fmt: off` and `# fmt: on` are implemented (#5)
 


@@ -453,7 +586,7 @@
   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
   (#68)
 
   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
   (#68)
 

-### 18.3a3
+## 18.3a3

 
 - don't remove single empty lines outside of bracketed expressions (#19)
 
 
 - don't remove single empty lines outside of bracketed expressions (#19)
 


@@ -463,7 +596,7 @@
 
 - even better handling of numpy-style array indexing (#33, again)
 
 
 - even better handling of numpy-style array indexing (#33, again)
 

-### 18.3a2
+## 18.3a2

 
 - changed positioning of binary operators to occur at beginning of lines instead of at
   the end, following
 
 - changed positioning of binary operators to occur at beginning of lines instead of at
   the end, following


@@ -487,7 +620,7 @@
 
 - fixed spurious space after star-based unary expressions (#31)
 
 
 - fixed spurious space after star-based unary expressions (#31)
 

-### 18.3a1
+## 18.3a1

 
 - added `--check`
 
 
 - added `--check`
 


@@ -506,10 +639,10 @@
 - fixed spurious space after unary operators when the operand was a complex expression
   (#15)
 
 - fixed spurious space after unary operators when the operand was a complex expression
   (#15)
 

-### 18.3a0
+## 18.3a0

 
 - first published version, Happy 🍰 Day 2018!
 
 - alpha quality
 
 
 - first published version, Happy 🍰 Day 2018!
 
 - alpha quality
 

-- date-versioned (see: https://calver.org/)
+- date-versioned (see: <https://calver.org/>)