From 2018e667a6a36ee3fbfa8041cd36512f92f60d49 Mon Sep 17 00:00:00 2001 From: Richard Si <63936253+ichard26@users.noreply.github.com> Date: Wed, 31 Aug 2022 18:39:54 -0400 Subject: [PATCH] Prepare docs for release 22.8.0 (#3248) --- CHANGES.md | 85 +++++++++++++-------- docs/integrations/source_version_control.md | 2 +- docs/usage_and_configuration/the_basics.md | 2 +- 3 files changed, 57 insertions(+), 32 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 6aa81a8..7c7be98 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,20 +6,68 @@ -### Style +### Stable style +### Preview style + + + +### Configuration + + + +### Packaging + + + +### Parser + + + +### Performance + + + +### Output + + + +### _Blackd_ + + + +### Integrations + + + +### Documentation + + + +## 22.8.0 + +### Highlights + +- Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as + of publishing (#3234) +- This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6 + code will continue to be supported until further notice) +- Reword the stability policy to say that we may, in rare cases, make changes that + affect code that was not previously formatted by _Black_ (#3155) + +### Stable style + - Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code block (#3158) -- Fix incorrect handling of `# fmt: skip` on colon `:` lines. (#3148) +- Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148) - Comments are no longer deleted when a line had spaces removed around power operators (#2874) ### Preview style - - - Single-character closing docstring quotes are no longer moved to their own line as this is invalid. This was a bug introduced in version 22.6.0. (#3166) - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being @@ -33,15 +81,11 @@ ### _Blackd_ - - -- `blackd` now supports preview style via `X-Preview` header (#3217) +- `blackd` now supports enabling the preview style via the `X-Preview` header (#3217) ### Configuration - - -- Black now uses the presence of debug f-strings to detect target version. (#3215) +- Black now uses the presence of debug f-strings to detect target version (#3215) - Fix misdetection of project root and verbose logging of sources in cases involving `--stdin-filename` (#3216) - Immediate `.gitignore` files in source directories given on the command line are now @@ -50,48 +94,29 @@ ### Documentation - - -- Reword the stability policy to say that we may, in rare cases, make changes that - affect code that was not previously formatted by _Black_ (#3155) - Recommend using BlackConnect in IntelliJ IDEs (#3150) ### Integrations - - - Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194) - Docker: changed to a /opt/venv installation + added to PATH to be available to non-root users (#3202) ### Output - - - Change from deprecated `asyncio.get_event_loop()` to create our event loop which removes DeprecationWarning (#3164) -- Remove logging from internal `blib2to3` library since it regularily emits error logs +- Remove logging from internal `blib2to3` library since it regularly emits error logs about failed caching that can and should be ignored (#3193) -### Packaging - - - -- Python 3.11 is now supported, except for `blackd` (#3234) - ### Parser - - - Type comments are now included in the AST equivalence check consistently so accidental deletion raises an error. Though type comments can't be tracked when running on PyPy 3.7 due to standard library limitations. (#2874) ### Performance - - - Reduce Black's startup time when formatting a single file by 15-30% (#3211) ## 22.6.0 diff --git a/docs/integrations/source_version_control.md b/docs/integrations/source_version_control.md index e897cf6..31d0df2 100644 --- a/docs/integrations/source_version_control.md +++ b/docs/integrations/source_version_control.md @@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you ```yaml repos: - repo: https://github.com/psf/black - rev: 22.6.0 + rev: 22.8.0 hooks: - id: black # It is recommended to specify the latest version of Python diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md index 4c35874..2dc2a14 100644 --- a/docs/usage_and_configuration/the_basics.md +++ b/docs/usage_and_configuration/the_basics.md @@ -173,7 +173,7 @@ You can check the version of _Black_ you have installed using the `--version` fl ```console $ black --version -black, version 22.6.0 +black, version 22.8.0 ``` An option to require a specific version to be running is also provided. -- 2.39.5