-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
||
### 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 | ||
|
@@ -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 | ||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.