From: Łukasz Langa Date: Sun, 16 May 2021 16:24:28 +0000 (+0200) Subject: Include Jelle's review suggestions X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/60f8bd2c89fbb370e6816fd6d6e5eca64d5b9f13 Include Jelle's review suggestions --- diff --git a/CHANGES.md b/CHANGES.md index 1a38bf6..f2c7954 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -4,15 +4,18 @@ ### _Black_ -- Fix typos discovered by codespell (#2228) - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227) -- Fix vim plugin installation instructions. (#2235) ### _Blackd_ - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is supported. (#2231) +### Documentation + +- Fix typos discovered by codespell (#2228) +- Fix Vim plugin installation instructions. (#2235) + ## 21.5b1 ### _Black_ diff --git a/docs/contributing/issue_triage.md b/docs/contributing/issue_triage.md index 780b2b5..9b987fb 100644 --- a/docs/contributing/issue_triage.md +++ b/docs/contributing/issue_triage.md @@ -116,7 +116,9 @@ it's totally cool to go with it instead. For most issues, closing the issue manually or automatically after a resolving PR is ideal. For bug reports specifically, if the bug has already been fixed, try to check in -with the issue opener that their specific case has been resolved before closing. +with the issue opener that their specific case has been resolved before closing. Note +that we close issues as soon as they're fixed in the `main` branch. This doesn't +necessarily mean they've been released yet. Design and enhancement issues should be also closed when it's clear the proposed change won't be implemented, whether that has been determined after a lot of discussion or just @@ -146,7 +148,7 @@ Here's some of the most common issues and also pre-made responses you can use: ```text Black used to remove the trailing comma if the expression fits in a single line, but this was changed by #826 and #1288. Now a trailing comma tells Black to always explode the expression. This change was made mostly for the cases where you _know_ a collection or whatever will grow in the future. Having it always exploded as one element per line reduces diff noise when adding elements. Before the "magic trailing comma" feature, you couldn't anticipate a collection's growth reliably since collections that fitted in one line were ruthlessly collapsed regardless of your intentions. One of Black's goals is reducing diff noise, so this was a good pragmatic change. -So no, this is not a bug, but an intended feature. Anyway, [here's the documentation](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#the-magic-trailing-comma) on the "magic trailing comma". Hopefully that helps and sorry for the possible confusion. +So no, this is not a bug, but an intended feature. Anyway, [here's the documentation](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#the-magic-trailing-comma) on the "magic trailing comma", including the ability to skip this functionality with the `--skip-magic-trailing-comma` option. Hopefully that helps solve the possible confusion. ``` ### "Black formatted code is violating Flake8's E203!"