Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare docs for release 22.8.0 #3248

Merged
merged 1 commit into from Aug 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
85 changes: 55 additions & 30 deletions CHANGES.md
Expand Up @@ -6,20 +6,68 @@

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

### Style
### Stable style

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

### 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)
Comment on lines +54 to +59
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the bit I'd appreciate eyes on the most.


### 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

<!-- Changes that affect Black's 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
Expand All @@ -33,15 +81,11 @@

### _Blackd_

<!-- Changes to 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

<!-- 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
`--stdin-filename` (#3216)
- Immediate `.gitignore` files in source directories given on the command line are now
Expand All @@ -50,48 +94,29 @@

### 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)

### Integrations

<!-- For example, Docker, GitHub Actions, pre-commit, editors -->

- 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

<!-- Changes to Black's terminal output and error messages -->

- 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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow this spelling error slipped into main haha

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

<!-- Changes to the parser or to version autodetection -->

- 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

<!-- Changes that improve Black's performance. -->

- Reduce Black's startup time when formatting a single file by 15-30% (#3211)

## 22.6.0
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/source_version_control.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/usage_and_configuration/the_basics.md
Expand Up @@ -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.
Expand Down