Skip to content

Commit 2018e66

Browse files
authored
Prepare docs for release 22.8.0 (#3248)
1 parent 0019261 commit 2018e66

File tree

3 files changed

+57
-32
lines changed

3 files changed

+57
-32
lines changed

CHANGES.md

+55-30
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,68 @@
66

77
<!-- Include any especially major or disruptive changes here -->
88

9-
### Style
9+
### Stable style
1010

1111
<!-- Changes that affect Black's stable style -->
1212

13+
### Preview style
14+
15+
<!-- Changes that affect Black's preview style -->
16+
17+
### Configuration
18+
19+
<!-- Changes to how Black can be configured -->
20+
21+
### Packaging
22+
23+
<!-- Changes to how Black is packaged, such as dependency requirements -->
24+
25+
### Parser
26+
27+
<!-- Changes to the parser or to version autodetection -->
28+
29+
### Performance
30+
31+
<!-- Changes that improve Black's performance. -->
32+
33+
### Output
34+
35+
<!-- Changes to Black's terminal output and error messages -->
36+
37+
### _Blackd_
38+
39+
<!-- Changes to blackd -->
40+
41+
### Integrations
42+
43+
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
44+
45+
### Documentation
46+
47+
<!-- Major changes to documentation and policies. Small docs changes
48+
don't need a changelog entry. -->
49+
50+
## 22.8.0
51+
52+
### Highlights
53+
54+
- Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as
55+
of publishing (#3234)
56+
- This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6
57+
code will continue to be supported until further notice)
58+
- Reword the stability policy to say that we may, in rare cases, make changes that
59+
affect code that was not previously formatted by _Black_ (#3155)
60+
61+
### Stable style
62+
1363
- Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code
1464
block (#3158)
15-
- Fix incorrect handling of `# fmt: skip` on colon `:` lines. (#3148)
65+
- Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148)
1666
- Comments are no longer deleted when a line had spaces removed around power operators
1767
(#2874)
1868

1969
### Preview style
2070

21-
<!-- Changes that affect Black's preview style -->
22-
2371
- Single-character closing docstring quotes are no longer moved to their own line as
2472
this is invalid. This was a bug introduced in version 22.6.0. (#3166)
2573
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
@@ -33,15 +81,11 @@
3381

3482
### _Blackd_
3583

36-
<!-- Changes to blackd -->
37-
38-
- `blackd` now supports preview style via `X-Preview` header (#3217)
84+
- `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
3985

4086
### Configuration
4187

42-
<!-- Changes to how Black can be configured -->
43-
44-
- Black now uses the presence of debug f-strings to detect target version. (#3215)
88+
- Black now uses the presence of debug f-strings to detect target version (#3215)
4589
- Fix misdetection of project root and verbose logging of sources in cases involving
4690
`--stdin-filename` (#3216)
4791
- Immediate `.gitignore` files in source directories given on the command line are now
@@ -50,48 +94,29 @@
5094

5195
### Documentation
5296

53-
<!-- Major changes to documentation and policies. Small docs changes
54-
don't need a changelog entry. -->
55-
56-
- Reword the stability policy to say that we may, in rare cases, make changes that
57-
affect code that was not previously formatted by _Black_ (#3155)
5897
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
5998

6099
### Integrations
61100

62-
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
63-
64101
- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
65102
- Docker: changed to a /opt/venv installation + added to PATH to be available to
66103
non-root users (#3202)
67104

68105
### Output
69106

70-
<!-- Changes to Black's terminal output and error messages -->
71-
72107
- Change from deprecated `asyncio.get_event_loop()` to create our event loop which
73108
removes DeprecationWarning (#3164)
74-
- Remove logging from internal `blib2to3` library since it regularily emits error logs
109+
- Remove logging from internal `blib2to3` library since it regularly emits error logs
75110
about failed caching that can and should be ignored (#3193)
76111

77-
### Packaging
78-
79-
<!-- Changes to how Black is packaged, such as dependency requirements -->
80-
81-
- Python 3.11 is now supported, except for `blackd` (#3234)
82-
83112
### Parser
84113

85-
<!-- Changes to the parser or to version autodetection -->
86-
87114
- Type comments are now included in the AST equivalence check consistently so accidental
88115
deletion raises an error. Though type comments can't be tracked when running on PyPy
89116
3.7 due to standard library limitations. (#2874)
90117

91118
### Performance
92119

93-
<!-- Changes that improve Black's performance. -->
94-
95120
- Reduce Black's startup time when formatting a single file by 15-30% (#3211)
96121

97122
## 22.6.0

docs/integrations/source_version_control.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
77
```yaml
88
repos:
99
- repo: https://github.com/psf/black
10-
rev: 22.6.0
10+
rev: 22.8.0
1111
hooks:
1212
- id: black
1313
# It is recommended to specify the latest version of Python

docs/usage_and_configuration/the_basics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ You can check the version of _Black_ you have installed using the `--version` fl
173173

174174
```console
175175
$ black --version
176-
black, version 22.6.0
176+
black, version 22.8.0
177177
```
178178

179179
An option to require a specific version to be running is also provided.

0 commit comments

Comments
 (0)