X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/5cfea54c15167e8ba68fde6bcf10d70575697c13..52fda8b0e9e52e94aae6cb3170c9b1b492a2d8b4:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 9522ec5..e2f91ef 100644 --- a/README.md +++ b/README.md @@ -230,11 +230,9 @@ 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. +after module-level functions. *Black* will not put empty lines between +function/class definitions and standalone comments that immediately precede +the given function/class. ### Trailing commas @@ -368,9 +366,21 @@ Configuration: * `g:black_linelength` (defaults to `88`) * `g:black_virtualenv` (defaults to `~/.vim/black`) -To install, copy the plugin from [vim/plugin/black.vim](https://github.com/ambv/black/tree/master/vim/plugin/black.vim). +To install with [vim-plug](https://github.com/junegunn/vim-plug): + +``` +Plug 'ambv/black', +``` + +or with [Vundle](https://github.com/VundleVim/Vundle.vim): + +``` +Plugin 'ambv/black' +``` + +or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim). Let me know if this requires any changes to work with Vim 8's builtin -`packadd`, or Pathogen, or Vundle, and so on. +`packadd`, or Pathogen, and so on. This plugin **requires Vim 7.0+ built with Python 3.6+ support**. It needs Python 3.6 to be able to run *Black* inside the Vim process which @@ -513,11 +523,22 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * added a "cache"; files already reformatted that haven't changed on disk won't be reformatted again (#109) +* `--check` and `--diff` are no longer mutually exclusive (#149) + * generalized star expression handling, including double stars; this fixes multiplication making expressions "unsafe" for trailing commas (#132) -* fix parsing of complex expressions after star and double stars in - function parameters (#2) +* fixed comment indentation when a standalone comment closes a block (#16, #32) + +* fixed standalone comments receiving extra empty lines if immediately preceding + a class, def, or decorator (#56, #154) + +* fixed `--diff` not showing entire path (#130) + +* fixed parsing of complex expressions after star and double stars in + function calls (#2) + +* fixed invalid splitting on comma in lambda arguments (#133) ### 18.4a2 @@ -682,3 +703,4 @@ Multiple contributions by: * [Ivan Katanić](mailto:ivan.katanic@gmail.com) * [Jonas Obrist](mailto:ojiidotch@gmail.com) * [Osaetin Daniel](mailto:osaetindaniel@gmail.com) +* [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)