Prepare release 26.5.1 (#5140)
* Prepare release 26.5.1
Closes #5137
Signed-off-by: cobalt <61329810+cobaltt7@users.noreply.github.com>
* Mention #5137 in changelog
this isn't a pr, but there isn't really a pr that fixed this per se
Signed-off-by: cobalt <61329810+cobaltt7@users.noreply.github.com>
* Update CHANGES.md
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
---------
Signed-off-by: cobalt <61329810+cobaltt7@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
diff --git a/CHANGES.md b/CHANGES.md
index 86ed3d8..b710349 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,62 +1,20 @@
# Change Log
-## Unreleased
-
-<!-- PR authors:
- Please include the PR number in the changelog entry, not the issue number -->
-
-### Highlights
-
-<!-- Include any especially major or disruptive changes here -->
+## Version 26.5.1
### Stable style
-<!-- Changes that affect Black's stable style -->
-
- Fix unstable formatting of annotated assignments whose subscript annotation contains
- an inline comment (e.g. `x: list[ # pyright: ignore[...]\n int\n] = []`). Black no
- longer migrates the comment outside the subscript brackets, eliminating the
- oscillation between formatter passes reported as #4733 (#5130)
+ an inline comment (e.g. `x: list[ # pyright: ignore[...]`) (#5130)
- Preserve inline comments (including `# type: ignore`) immediately before a
`# fmt: skip` line, avoiding AST equivalence failures (#5139)
-### 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 -->
+- Correct the version in the published executables (#5137)
### Documentation
-<!-- Major changes to documentation and policies. Small docs changes
- don't need a changelog entry. -->
-
- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
(#5124)
diff --git a/docs/guides/using_black_with_jupyter_notebooks.md b/docs/guides/using_black_with_jupyter_notebooks.md
index d5f2b53..1743f0b 100644
--- a/docs/guides/using_black_with_jupyter_notebooks.md
+++ b/docs/guides/using_black_with_jupyter_notebooks.md
@@ -111,7 +111,7 @@
```yaml
repos:
- repo: https://github.com/psf/black-pre-commit-mirror
- rev: 26.5.0
+ rev: 26.5.1
hooks:
- id: black-jupyter
language_version: python3.11
diff --git a/docs/integrations/source_version_control.md b/docs/integrations/source_version_control.md
index 09007ec..2d17847 100644
--- a/docs/integrations/source_version_control.md
+++ b/docs/integrations/source_version_control.md
@@ -8,7 +8,7 @@
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: 26.5.0
+ rev: 26.5.1
hooks:
- id: black
# It is recommended to specify the latest version of Python
@@ -34,7 +34,7 @@
```yaml
repos:
- repo: https://github.com/psf/black-pre-commit-mirror
- rev: 26.5.0
+ rev: 26.5.1
hooks:
- id: black-jupyter
language_version: python3.11
@@ -64,7 +64,7 @@
```yaml
repos:
- repo: https://github.com/psf/black-pre-commit-mirror
- rev: 26.5.0
+ rev: 26.5.1
hooks:
- id: black
exclude: ^migrations/|^generated/
diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md
index afdf60a..4e34f70 100644
--- a/docs/usage_and_configuration/the_basics.md
+++ b/docs/usage_and_configuration/the_basics.md
@@ -280,8 +280,8 @@
```console
$ black --version
-black, 26.5.0 (compiled: yes)
-$ black --required-version 26.5.0 -c "format = 'this'"
+black, 26.5.1 (compiled: yes)
+$ black --required-version 26.5.1 -c "format = 'this'"
format = "this"
$ black --required-version 31.5b2 -c "still = 'beta?!'"
Oh no! 💥 💔 💥 The required version does not match the running version!
@@ -388,7 +388,7 @@
```console
$ black --version
-black, 26.5.0
+black, 26.5.1
```
#### `--config`