README.rst

   1 vim-python-pep8-indent
   2 ======================
   3
   4 This small script modifies vim_’s indentation behavior to comply with PEP8_ and
   5 my aesthetic preferences: ::
   6
   7    foobar(foo,
   8           bar)
   9
  10 and ::
  11
  12    foobar(
  13       foo,
  14       bar
  15    )
  16
  17 It was *not* originally written by me. I have found the script in vim’s `script
  18 repo`_, however the indentation was off by one character in the first case.
  19
  20 I fixed it with the help of `Steve Losh`_ and am putting it out here so you
  21 don’t have to patch the original. The original patch is still available here_.
  22
  23 While my Vimscript_ skills are still feeble, I intend to maintain it for now.
  24 So feel free to report bugs, I’ll try to address them as good as possible if
  25 they fit into the scope of this project.
  26
  27 Unfortunately, I wasn’t able to reach any of the original authors/maintainers:
  28 **David Bustos** and **Eric Mc Sween**. I’d like to thank them here for their
  29 work and release it hereby to the *Public Domain*. If anyone – who has a say in
  30 this – objects, please let me know.
  31
  32 Installation
  33 ------------
  34
  35 The easiest way is to use pathogen_ and do a ::
  36
  37    git clone https://github.com/hynek/vim-python-pep8-indent.git
  38
  39 in your `~/.vim/bundle`. And you *should* use pathogen. Really.
  40
  41 Please note that Kirill Klenov’s python-mode_ ships an own version of of this
  42 bundle.  Therefore, if you want to use this version specifically, you’ll have
  43 to disable python-mode’s using: ::
  44
  45    let g:pymode_indent = 0
  46
  47 .. _vim: http://www.vim.org/
  48 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
  49 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
  50 .. _`Steve Losh`: http://stevelosh.com/
  51 .. _here: https://gist.github.com/2965846
  52 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
  53 .. _pathogen: https://github.com/tpope/vim-pathogen
  54 .. _python-mode: https://github.com/klen/python-mode