]> git.madduck.net Git - etc/vim.git/blobdiff - CHANGES.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:

Don't run Docker workflow on push to forks (#2324)
[etc/vim.git] / CHANGES.md
index 6340f60ae59ec71a85e5347b4c0120613fdba56b..01c02fe2b70a30cc8b59466ef60b064bbe7fbb19 100644 (file)
@@ -1,8 +1,137 @@
-## Change Log
+# Change Log
 
-### Unreleased
+## Unreleased
 
-#### _Black_
+### _Black_
+
+- Fix failure caused by `fmt: skip` and indentation (#2281)
+- Account for += assignment when deciding whether to split string (#2312)
+- Correct max string length calculation when there are string operators (#2292)
+- Fixed option usage when using the `--code` flag (#2259)
+- Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
+- Added `--required-version` option to require a specific version to be running (#2300)
+- Fix incorrect custom breakpoint indices when string group contains fake f-strings
+  (#2311)
+- Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
+- Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
+  used (#2319)
+
+## 21.5b2
+
+### _Black_
+
+- A space is no longer inserted into empty docstrings (#2249)
+- Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
+- 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)
+- Add extra uvloop install + import support if in python env (#2258)
+- Fix --experimental-string-processing crash when matching parens are not found (#2283)
+- Make sure to split lines that start with a string operator (#2286)
+- Fix regular expression that black uses to identify f-expressions (#2287)
+
+### _Blackd_
+
+- Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
+  supported. (#2231)
+
+### Integrations
+
+- The official Black action now supports choosing what version to use, and supports the
+  major 3 OSes. (#1940)
+
+### Packaging
+
+- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
+  (#2198)
+- Always build binaries with the latest available Python (#2260)
+
+### Documentation
+
+- Add discussion of magic comments to FAQ page (#2272)
+- `--experimental-string-processing` will be enabled by default in the future (#2273)
+- Fix typos discovered by codespell (#2228)
+- Fix Vim plugin installation instructions. (#2235)
+- Add new Frequently Asked Questions page (#2247)
+- Fix encoding + symlink issues preventing proper build on Windows (#2262)
+
+## 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)
 - Added parsing support for unparenthesized tuples and yield expressions in annotated
   assignments (#1835)
 
-- use lowercase hex strings (#1692)
-
 - added `--extend-exclude` argument (PR #2005)
 
 - speed up caching by avoiding pathlib (#1950)
 
 - Exclude `venv` directory by default (#1683)
 
-#### _Packaging_
+- 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
+## 20.8b1
 
-#### _Packaging_
+### _Packaging_
 
 - 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)
   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)
 
-### 19.10b0
+## 19.10b0
 
 - added support for PEP 572 assignment expressions (#711)
 
 - `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)
 
 - `blackd` now supports CORS (#622)
 
-### 18.9b0
+## 18.9b0
 
 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
 
 
   - 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)
 
 - 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)
 
-### 18.6b3
+## 18.6b3
 
 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
 
 
 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
 
-### 18.6b2
+## 18.6b2
 
 - added `--config` (#65)
 
 
 - 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)
 
-### 18.6b0
+## 18.6b0
 
 - added `--include` and `--exclude` (#270)
 
 
 - _Black_ now preserves line endings when formatting a file in place (#258)
 
-### 18.5b1
+## 18.5b1
 
 - added `--pyi` (#249)
 
 - 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)
 
 - fixed crash when dead symlinks where encountered
 
-### 18.4a4
+## 18.4a4
 
 - 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)
 
 - fixed missing splits of ternary expressions (#141)
 
-### 18.4a2
+## 18.4a2
 
 - fixed parsing of unaligned standalone comments (#99, #112)
 
 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
   (#120)
 
-### 18.4a1
+## 18.4a1
 
 - added `--quiet` (#78)
 
 
 - fixed removing backslash escapes from raw strings (#100, #105)
 
-### 18.4a0
+## 18.4a0
 
 - added `--diff` (#87)
 
 - 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)
 
   [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)
 
 
 - 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
 
 - fixed spurious space after star-based unary expressions (#31)
 
-### 18.3a1
+## 18.3a1
 
 - added `--check`
 
 - 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
 
-- date-versioned (see: https://calver.org/)
+- date-versioned (see: <https://calver.org/>)