X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/155aa71db01a0cb22b64006082c356295e1eecfb..5fa38d4c3bdae68abfe235709b69b1bc8ae75c3a:/README.md?ds=sidebyside diff --git a/README.md b/README.md index a124429..0978887 100644 --- a/README.md +++ b/README.md @@ -183,9 +183,27 @@ explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you overdo it by a few km/h". +### Empty lines + +*Black* will allow single empty lines left by the original editors, +except when they're added within parenthesized expressions. Since such +expressions are always reformatted to fit minimal space, this whitespace +is lost. + +It will also insert proper spacing before and after function definitions. +It's one line before and after inner functions and two lines before and +after module-level functions. *Black* will put those empty lines also +between the function definition and any standalone comments that +immediately precede the given function. If you want to comment on the +entire function, use a docstring or put a leading comment in the function +body. + + ### Editor integration -There is currently no integration with any text editors. Vim and +* Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode) + +There is currently no integration with any other text editors. Vim and Atom/Nuclide integration is planned by the author, others will require external contributions. @@ -259,8 +277,17 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.3a3 +* don't remove single empty lines outside of bracketed expressions + (#19) + * added ability to pipe formatting from stdin to stdin (#25) +* restored ability to format code with legacy usage of `async` as + a name (#20, #42) + +* even better handling of numpy-style array indexing (#33, again) + + ### 18.3a2 * changed positioning of binary operators to occur at beginning of lines