Prepare docs for release 22.8.0 (#3248)
This commit is contained in:
parent
0019261abc
commit
2018e667a6
91
CHANGES.md
91
CHANGES.md
@ -6,20 +6,68 @@
|
|||||||
|
|
||||||
<!-- Include any especially major or disruptive changes here -->
|
<!-- Include any especially major or disruptive changes here -->
|
||||||
|
|
||||||
### Style
|
### Stable style
|
||||||
|
|
||||||
<!-- Changes that affect Black's stable style -->
|
<!-- Changes that affect Black's 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)
|
|
||||||
- Comments are no longer deleted when a line had spaces removed around power operators
|
|
||||||
(#2874)
|
|
||||||
|
|
||||||
### Preview style
|
### Preview style
|
||||||
|
|
||||||
<!-- Changes that affect Black's preview style -->
|
<!-- Changes that affect Black's preview style -->
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
<!-- Changes to how Black can be configured -->
|
||||||
|
|
||||||
|
### Packaging
|
||||||
|
|
||||||
|
<!-- Changes to how Black is packaged, such as dependency requirements -->
|
||||||
|
|
||||||
|
### Parser
|
||||||
|
|
||||||
|
<!-- Changes to the parser or to version autodetection -->
|
||||||
|
|
||||||
|
### Performance
|
||||||
|
|
||||||
|
<!-- Changes that improve Black's performance. -->
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<!-- Changes to Black's terminal output and error messages -->
|
||||||
|
|
||||||
|
### _Blackd_
|
||||||
|
|
||||||
|
<!-- Changes to blackd -->
|
||||||
|
|
||||||
|
### Integrations
|
||||||
|
|
||||||
|
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
<!-- Major changes to documentation and policies. Small docs changes
|
||||||
|
don't need a changelog entry. -->
|
||||||
|
|
||||||
|
## 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)
|
||||||
|
- 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
|
- 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)
|
this is invalid. This was a bug introduced in version 22.6.0. (#3166)
|
||||||
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
|
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
|
||||||
@ -33,15 +81,11 @@
|
|||||||
|
|
||||||
### _Blackd_
|
### _Blackd_
|
||||||
|
|
||||||
<!-- Changes to blackd -->
|
- `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
|
||||||
|
|
||||||
- `blackd` now supports preview style via `X-Preview` header (#3217)
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
<!-- Changes to how Black can be configured -->
|
- 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
|
- Fix misdetection of project root and verbose logging of sources in cases involving
|
||||||
`--stdin-filename` (#3216)
|
`--stdin-filename` (#3216)
|
||||||
- Immediate `.gitignore` files in source directories given on the command line are now
|
- Immediate `.gitignore` files in source directories given on the command line are now
|
||||||
@ -50,48 +94,29 @@
|
|||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
<!-- Major changes to documentation and policies. Small docs changes
|
|
||||||
don't need a changelog entry. -->
|
|
||||||
|
|
||||||
- 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)
|
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
|
||||||
|
|
||||||
### Integrations
|
### Integrations
|
||||||
|
|
||||||
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
|
|
||||||
|
|
||||||
- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
|
- 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
|
- Docker: changed to a /opt/venv installation + added to PATH to be available to
|
||||||
non-root users (#3202)
|
non-root users (#3202)
|
||||||
|
|
||||||
### Output
|
### Output
|
||||||
|
|
||||||
<!-- Changes to Black's terminal output and error messages -->
|
|
||||||
|
|
||||||
- Change from deprecated `asyncio.get_event_loop()` to create our event loop which
|
- Change from deprecated `asyncio.get_event_loop()` to create our event loop which
|
||||||
removes DeprecationWarning (#3164)
|
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)
|
about failed caching that can and should be ignored (#3193)
|
||||||
|
|
||||||
### Packaging
|
|
||||||
|
|
||||||
<!-- Changes to how Black is packaged, such as dependency requirements -->
|
|
||||||
|
|
||||||
- Python 3.11 is now supported, except for `blackd` (#3234)
|
|
||||||
|
|
||||||
### Parser
|
### Parser
|
||||||
|
|
||||||
<!-- Changes to the parser or to version autodetection -->
|
|
||||||
|
|
||||||
- Type comments are now included in the AST equivalence check consistently so accidental
|
- 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
|
deletion raises an error. Though type comments can't be tracked when running on PyPy
|
||||||
3.7 due to standard library limitations. (#2874)
|
3.7 due to standard library limitations. (#2874)
|
||||||
|
|
||||||
### Performance
|
### Performance
|
||||||
|
|
||||||
<!-- Changes that improve Black's performance. -->
|
|
||||||
|
|
||||||
- Reduce Black's startup time when formatting a single file by 15-30% (#3211)
|
- Reduce Black's startup time when formatting a single file by 15-30% (#3211)
|
||||||
|
|
||||||
## 22.6.0
|
## 22.6.0
|
||||||
|
@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
|
|||||||
```yaml
|
```yaml
|
||||||
repos:
|
repos:
|
||||||
- repo: https://github.com/psf/black
|
- repo: https://github.com/psf/black
|
||||||
rev: 22.6.0
|
rev: 22.8.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: black
|
- id: black
|
||||||
# It is recommended to specify the latest version of Python
|
# It is recommended to specify the latest version of Python
|
||||||
|
@ -173,7 +173,7 @@ You can check the version of _Black_ you have installed using the `--version` fl
|
|||||||
|
|
||||||
```console
|
```console
|
||||||
$ black --version
|
$ 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.
|
An option to require a specific version to be running is also provided.
|
||||||
|
Loading…
Reference in New Issue
Block a user