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 release 23.10.0 #3951

Merged
merged 1 commit into from Oct 17, 2023
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
60 changes: 37 additions & 23 deletions CHANGES.md
Expand Up @@ -10,25 +10,14 @@

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

- Fix comments getting removed from inside parenthesized strings (#3909)

### Preview style

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

- Fix long lines with power operators getting splitted before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across
multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)

### Configuration

<!-- Changes to how Black can be configured -->

- Fix cache versioning logic when `BLACK_CACHE_DIR` is set (#3937)

### Packaging

<!-- Changes to how Black is packaged, such as dependency requirements -->
Expand All @@ -37,11 +26,6 @@

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

- Fix bug where attributes named `type` were not acccepted inside `match` statements
(#3950)
- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
(#3949)

### Performance

<!-- Changes that improve Black's performance. -->
Expand All @@ -50,11 +34,6 @@

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

- Black no longer attempts to provide special errors for attempting to format Python 2
code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode
(#3938)

### _Blackd_

<!-- Changes to blackd -->
Expand All @@ -63,13 +42,48 @@

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

- The action output displayed in the job summary is now wrapped in Markdown (#3914)

### Documentation

<!-- Major changes to documentation and policies. Small docs changes
don't need a changelog entry. -->

## 23.10.0

### Stable style

- Fix comments getting removed from inside parenthesized strings (#3909)

### Preview style

- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across
multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)

### Configuration

- Fix cache versioning logic when `BLACK_CACHE_DIR` is set (#3937)

### Parser

- Fix bug where attributes named `type` were not acccepted inside `match` statements
(#3950)
- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
(#3949)

### Output

- Black no longer attempts to provide special errors for attempting to format Python 2
code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode
(#3938)

### Integrations

- The action output displayed in the job summary is now wrapped in Markdown (#3914)

## 23.9.1

Due to various issues, the previous release (23.9.0) did not include compiled mypyc
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/source_version_control.md
Expand Up @@ -8,7 +8,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
repos:
# Using this mirror lets us use mypyc-compiled black, which is about 2x faster
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 23.9.1
rev: 23.10.0
hooks:
- id: black
# It is recommended to specify the latest version of Python
Expand All @@ -35,7 +35,7 @@ include Jupyter Notebooks. To use this hook, simply replace the hook's `id: blac
repos:
# Using this mirror lets us use mypyc-compiled black, which is about 2x faster
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 23.9.1
rev: 23.10.0
hooks:
- id: black-jupyter
# It is recommended to specify the latest version of Python
Expand Down
6 changes: 3 additions & 3 deletions docs/usage_and_configuration/the_basics.md
Expand Up @@ -194,8 +194,8 @@ configuration file for consistent results across environments.

```console
$ black --version
black, 23.9.1 (compiled: yes)
$ black --required-version 23.9.1 -c "format = 'this'"
black, 23.10.0 (compiled: yes)
$ black --required-version 23.10.0 -c "format = 'this'"
format = "this"
$ black --required-version 31.5b2 -c "still = 'beta?!'"
Oh no! 💥 💔 💥 The required version does not match the running version!
Expand Down Expand Up @@ -286,7 +286,7 @@ You can check the version of _Black_ you have installed using the `--version` fl

```console
$ black --version
black, 23.9.1
black, 23.10.0
```

#### `--config`
Expand Down