X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e39edb5a32f6468b134df24f45cc1a01d1662238..21bc78d9a3a17653dd5ea1f6a6c92445d23b215b:/README.mdown diff --git a/README.mdown b/README.mdown index 2f8c5b6..692baad 100644 --- a/README.mdown +++ b/README.mdown @@ -5,17 +5,17 @@ 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](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes -(static syntax checker), PEP8 (style checker) -and Ned's MacCabe script (complexity checker). +[Flake8](https://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes +(static syntax checker), PEP8 (style checker) and Ned's MacCabe script +(complexity checker). Installation ------------ Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using -it already. Make sure you've installed the [flake8](http://pypi.python.org/pypi/flake8/) package. -Then, simply put the contents of this repository in your -`~/.vim/bundle` directory. +it already. Make sure you've installed the +[flake8](https://pypi.python.org/pypi/flake8/) package. Then, simply put the +contents of this repository in your `~/.vim/bundle` directory. Usage ----- @@ -41,7 +41,7 @@ the `` key if so. For example, to remap it to `` instead, use: For flake8 configuration options please consult the following page: -http://flake8.readthedocs.org/en/latest/config.html +https://flake8.readthedocs.org/en/latest/config.html To customize the location of your flake8 binary, set `g:flake8_cmd`: @@ -51,6 +51,10 @@ To customize the location of quick fix window, set `g:flake8_quickfix_location`: let g:flake8_quickfix_location="topleft" +To customize the height of quick fix window, set `g:flake8_quickfix_height`: + + let g:flake8_quickfix_height=7 + To customize whether the quickfix window opens, set `g:flake8_show_quickfix`: let g:flake8_show_quickfix=0 " don't show @@ -94,21 +98,32 @@ Tips ---- A tip might be to run the Flake8 check every time you write a Python file, to enable this, add the following line to your `.vimrc` file (thanks -[Godefroid](http://github.com/gotcha)!): +[Godefroid](https://github.com/gotcha)!): autocmd BufWritePost *.py call Flake8() This plugin goes well together with the following plugin: -- [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `` +- [PyUnit](https://github.com/nvie/vim-pyunit) (unit test helper under `` and ``) History ------- +1.6: Deprecated configuring flake8 options through Vim settings. Instead, +advise users to use the `~/.config/flake8` config file. + + - Decprecated options: + - `g:flake8_builtins` + - `g:flake8_ignore` + - `g:flake8_max_line_length` + - `g:flake8_max_complexity` + + - New options: + - `g:flake8_quickfix_height` -1.5: Added markers and the option to don't show the quickfix window, also split functions into -a autoload file. Added: +1.5: Added markers and the option to don't show the quickfix window, also split +functions into a autoload file. Added: - Options: - `g:flake8_show_quickfix`