Skip to content

Commit

Permalink
correct Vim integration code (#2853)
Browse files Browse the repository at this point in the history
- use `Black` directly: the commands an autocommand runs are Ex commands, so no
  execute or colon is necessary.
- use an `augroup` (best practice) to prevent duplicate autocommands from
  hindering performance.
  • Loading branch information
benknoble committed Feb 21, 2022
1 parent 50a8569 commit 8089aaa
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/integrations/editors.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,13 @@ If you need to do anything special to make your virtualenv work and install _Bla
example you want to run a version from main), create a virtualenv manually and point
`g:black_virtualenv` to it. The plugin will use it.

To run _Black_ on save, add the following line to `.vimrc` or `init.vim`:
To run _Black_ on save, add the following lines to `.vimrc` or `init.vim`:

```
autocmd BufWritePre *.py execute ':Black'
augroup black_on_save
autocmd!
autocmd BufWritePre *.py Black
augroup end
```

To run _Black_ on a key press (e.g. F9 below), add this:
Expand Down

0 comments on commit 8089aaa

Please sign in to comment.