Mercurial > public > dotfiles
comparison vim/vimfiles/bundle/pyflakes-vim/README.rst @ 8:097c95760fd0
Added pyflakes-vim plugin support.
| author | Brian Neal <bgneal@gmail.com> |
|---|---|
| date | Sun, 29 Apr 2012 16:30:44 -0500 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 7:86e0ac713642 | 8:097c95760fd0 |
|---|---|
| 1 pyflakes-vim | |
| 2 ============ | |
| 3 | |
| 4 A Vim plugin for checking Python code on the fly. | |
| 5 | |
| 6 PyFlakes catches common Python errors like mistyping a variable name or | |
| 7 accessing a local before it is bound, and also gives warnings for things like | |
| 8 unused imports. | |
| 9 | |
| 10 pyflakes-vim uses the output from PyFlakes to highlight errors in your code. | |
| 11 To locate errors quickly, use quickfix_ commands like :cc. | |
| 12 | |
| 13 Make sure to check vim.org_ for the latest updates. | |
| 14 | |
| 15 .. _pyflakes.vim: http://www.vim.org/scripts/script.php?script_id=2441 | |
| 16 .. _vim.org: http://www.vim.org/scripts/script.php?script_id=2441 | |
| 17 .. _quickfix: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#quickfix | |
| 18 | |
| 19 Quick Installation | |
| 20 ------------------ | |
| 21 | |
| 22 1. Make sure your ``.vimrc`` has:: | |
| 23 | |
| 24 filetype on " enables filetype detection | |
| 25 filetype plugin on " enables filetype specific plugins | |
| 26 | |
| 27 2. Download the latest release_. | |
| 28 | |
| 29 3. If you're using pathogen_, unzip the contents of ``pyflakes-vim.zip`` into | |
| 30 its own bundle directory, i.e. into ``~/.vim/bundle/pyflakes-vim/``. | |
| 31 | |
| 32 Otherwise unzip ``pyflakes.vim`` and the ``pyflakes`` directory into | |
| 33 ``~/.vim/ftplugin/python`` (or somewhere similar on your | |
| 34 `runtime path`_ that will be sourced for Python files). | |
| 35 | |
| 36 .. _release: http://www.vim.org/scripts/script.php?script_id=2441 | |
| 37 .. _pathogen: http://www.vim.org/scripts/script.php?script_id=2332 | |
| 38 .. _runtime path: http://vimdoc.sourceforge.net/htmldoc/options.html#'runtimepath' | |
| 39 | |
| 40 Running from source | |
| 41 ------------------- | |
| 42 | |
| 43 If you're running pyflakes-vim "from source," you'll need the PyFlakes library | |
| 44 on your PYTHONPATH somewhere. (It is included in the vim.org zipfile.) I recommend | |
| 45 getting my PyFlakes_ fork, which retains column number information, giving more | |
| 46 specific error locations. | |
| 47 | |
| 48 .. _vim.org: http://www.vim.org/scripts/script.php?script_id=2441 | |
| 49 .. _PyFlakes: http://github.com/kevinw/pyflakes | |
| 50 | |
| 51 Hacking | |
| 52 ------- | |
| 53 | |
| 54 :: | |
| 55 | |
| 56 git clone git://github.com/kevinw/pyflakes-vim.git | |
| 57 cd pyflakes-vim | |
| 58 git clone git://github.com/kevinw/pyflakes.git | |
| 59 | |
| 60 Options | |
| 61 ------- | |
| 62 | |
| 63 Set this option to you vimrc file to disable quickfix support:: | |
| 64 | |
| 65 let g:pyflakes_use_quickfix = 0 | |
| 66 | |
| 67 The value is set to 1 by default. | |
| 68 | |
| 69 TODO | |
| 70 ---- | |
| 71 * signs_ support (show warning and error icons to left of the buffer area) | |
| 72 * configuration variables | |
| 73 * parse or intercept useful output from the warnings module | |
| 74 | |
| 75 .. _signs: http://www.vim.org/htmldoc/sign.html | |
| 76 | |
| 77 Changelog | |
| 78 --------- | |
| 79 | |
| 80 Please see http://www.vim.org/scripts/script.php?script_id=2441 for a history of | |
| 81 all changes. | |
| 82 |