From f6c139c5215ce04fd3e73a900f1372942d58eca0 Mon Sep 17 00:00:00 2001 From: Richard Si <63936253+ichard26@users.noreply.github.com> Date: Mon, 27 Jun 2022 20:33:35 -0400 Subject: [PATCH] Prepare docs for release 22.6.0 (#3139) --- CHANGES.md | 55 +++++++++++++-------- docs/integrations/source_version_control.md | 9 ++-- docs/usage_and_configuration/the_basics.md | 2 +- 3 files changed, 42 insertions(+), 24 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 7001271..b33ae6d 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -10,19 +10,10 @@ -- Fix unstable formatting involving `# fmt: skip` comments without internal spaces - (#2970) - ### 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_ @@ -40,18 +31,48 @@ -- Add migrate-black.py script to ease migration to black formatted git project (#3038) - ### Output -- Output python version and implementation as part of `--version` flag (#2997) - ### Packaging +### Parser + + + +### 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) - - -### 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 diff --git a/docs/integrations/source_version_control.md b/docs/integrations/source_version_control.md index d7d3da4..e897cf6 100644 --- a/docs/integrations/source_version_control.md +++ b/docs/integrations/source_version_control.md @@ -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]: diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md index c7e2d4a..7f76c57 100644 --- a/docs/usage_and_configuration/the_basics.md +++ b/docs/usage_and_configuration/the_basics.md @@ -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. -- 2.39.5