]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Prepare docs for release 22.8.0 (#3248)
authorRichard Si <63936253+ichard26@users.noreply.github.com>
Wed, 31 Aug 2022 22:39:54 +0000 (18:39 -0400)
committerGitHub <noreply@github.com>
Wed, 31 Aug 2022 22:39:54 +0000 (18:39 -0400)
CHANGES.md
docs/integrations/source_version_control.md
docs/usage_and_configuration/the_basics.md

index 6aa81a8f5c2404dd0cc8f2fb6bafb5bf2b420b74..7c7be98f71637b56cbfe17e831982679676b52c3 100644 (file)
@@ -6,20 +6,68 @@
 
 <!-- Include any especially major or disruptive changes here -->
 
 
 <!-- Include any especially major or disruptive changes here -->
 
-### Style
+### Stable style
 
 <!-- Changes that affect Black's 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 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
 
 - 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
 - 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
 
 ### _Blackd_
 
 
 ### _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
 
 
 ### 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
 - 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
 
 ### Documentation
 
 
 ### 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
 
 - 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
 
 - 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)
 - 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
   about failed caching that can and should be ignored (#3193)
 
   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
 
 ### 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
 
 - 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
 - Reduce Black's startup time when formatting a single file by 15-30% (#3211)
 
 ## 22.6.0
index e897cf669fc6b2ab6ba382c8c797dd5e09e4dff5..31d0df27273e104fda3feafcee46d1fd48829cec 100644 (file)
@@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
 ```yaml
 repos:
   - repo: https://github.com/psf/black
 ```yaml
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.8.0
     hooks:
       - id: black
         # It is recommended to specify the latest version of Python
     hooks:
       - id: black
         # It is recommended to specify the latest version of Python
index 4c358742674390e33834b64f8f2fb9db4d0d8941..2dc2a14f91af3585948f133a4f7e77816017b80c 100644 (file)
@@ -173,7 +173,7 @@ You can check the version of _Black_ you have installed using the `--version` fl
 
 ```console
 $ black --version
 
 ```console
 $ black --version
-black, version 22.6.0
+black, version 22.8.0
 ```
 
 An option to require a specific version to be running is also provided.
 ```
 
 An option to require a specific version to be running is also provided.