Prepare docs for release 22.6.0 (#3139)

This commit is contained in:
Richard Si 2022-06-27 20:33:35 -04:00 committed by GitHub
parent eb5d175c9c
commit f6c139c521
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 24 deletions

View File

@ -10,19 +10,10 @@
<!-- Changes that affect Black's stable style -->
- Fix unstable formatting involving `# fmt: skip` comments without internal spaces
(#2970)
### Preview style
<!-- Changes that affect Black's preview style -->
- Fixed bug where docstrings with triple quotes could exceed max line length (#3044)
- Remove redundant parentheses around awaited objects (#2991)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses from `with` statements (#2926)
- Remove trailing newlines after code block open (#3035)
### _Blackd_
<!-- Changes to blackd -->
@ -40,18 +31,48 @@
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
- Add migrate-black.py script to ease migration to black formatted git project (#3038)
### Output
<!-- Changes to Black's terminal output and error messages -->
- Output python version and implementation as part of `--version` flag (#2997)
### 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. -->
## 22.6.0
### Style
- Fix unstable formatting involving `#fmt: skip` and `# fmt:skip` comments (notice the
lack of spaces) (#2970)
### Preview style
- Docstring quotes are no longer moved if it would violate the line length limit (#3044)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses around awaited objects (#2991)
- Remove unnecessary parentheses in `with` statements (#2926)
- Remove trailing newlines after code block open (#3035)
### Integrations
- Add `scripts/migrate-black.py` script to ease introduction of Black to a Git project
(#3038)
### Output
- Output Python version and implementation as part of `--version` flag (#2997)
### Packaging
- Use `tomli` instead of `tomllib` on Python 3.11 builds where `tomllib` is not
available (#2987)
@ -62,15 +83,9 @@
- [PEP 646](https://peps.python.org/pep-0646) syntax (for example,
`Array[Batch, *Shape]` or `def fn(*args: *T) -> None`) is now supported (#3071)
<!-- Changes to the parser or to version autodetection -->
### Performance
<!-- Changes that improve Black's performance. -->
### Vim Plugin
- Fixed strtobool function. It didn't parse true/on/false/off. (#3025)
- Fix `strtobool` function. It didn't parse true/on/false/off. (#3025)
## 22.3.0

View File

@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
```yaml
repos:
- repo: https://github.com/psf/black
rev: 22.3.0
rev: 22.6.0
hooks:
- id: black
# It is recommended to specify the latest version of Python
@ -23,8 +23,11 @@ branches or other mutable refs since the hook [won't auto update as you may
expect][pre-commit-mutable-rev].
If you want support for Jupyter Notebooks as well, then replace `id: black` with
`id: black-jupyter` (though note that it's only available from version `21.8b0`
onwards).
`id: black-jupyter`.
```{note}
The `black-jupyter` hook is only available from version 21.8b0 and onwards.
```
[black-tags]: https://github.com/psf/black/tags
[pre-commit-mutable-rev]:

View File

@ -173,7 +173,7 @@ You can check the version of _Black_ you have installed using the `--version` fl
```console
$ black --version
black, version 22.3.0
black, version 22.6.0
```
An option to require a specific version to be running is also provided.