X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e338dadd0d83da0e77546451d71ad576aea7b187..2941a5201cf0c7050cf8750d1c4f311dd292940c:/README.mdown diff --git a/README.mdown b/README.mdown index fcfbab2..b84d224 100644 --- a/README.mdown +++ b/README.mdown @@ -1,5 +1,13 @@ -vim-flake8 ![Project status](http://stillmaintained.com/nvie/vim-flake8.png) +vim-flake8 ========== +`vim-flake8` is a Vim plugin that runs the currently open file through Flake8, +a static syntax and style checker for Python source code. It supersedes both +[vim-pyflakes](https://github.com/nvie/vim-pyflakes) and +[vim-pep8](https://github.com/nvie/vim-pep8). + +Flake8 is a wrapper around PyFlakes (static syntax checker), PEP8 (style +checker) and Ned's MacCabe script (complexity checker). + Installation ------------ @@ -33,6 +41,9 @@ enable this, add the following line to your `.vimrc` file (thanks autocmd BufWritePost *.py call Flake8() +To ignore errors, in your .vimrc: + + let g:flake8_ignore="E501,W293" This plugin goes well together with the following plugin: