]> git.madduck.net Git - etc/vim.git/blob - README.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

6ffaeb6d8e109172bff433e85c0f590edf1979dc
[etc/vim.git] / README.rst
1 vim-python-pep8-indent
2 ======================
3
4 .. image:: https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis
5    :target: https://travis-ci.org/hynek/vim-python-pep8-indent
6
7 This small script modifies vim_’s indentation behavior to comply with PEP8_ and my aesthetic preferences.
8 Most importantly::
9
10    foobar(foo,
11          bar)
12
13 and::
14
15    foobar(
16       foo,
17       bar
18    )
19
20
21 Installation
22 ------------
23
24
25 Pathogen
26 ^^^^^^^^
27
28 Follow the instructions on installing Pathogen_ and then:
29
30 .. code-block:: shell-session
31
32    $ cd ~/.vim/bundle
33    $ git clone https://github.com/hynek/vim-python-pep8-indent.git
34
35
36 Vundle
37 ######
38
39 Follow the instructions on installing Vundle_ and add the appropriate plugin line into your ``.vimrc``:
40
41 .. code-block:: vim
42
43    Plugin 'hynek/vim-python-pep8-indent'
44
45
46 NeoBundle
47 #########
48
49 Follow the instructions on installing NeoBundle_ and add the appropriate NeoBundle line into your ``.vimrc``:
50
51 .. code-block:: vim
52
53    NeoBundle 'hynek/vim-python-pep8-indent'
54
55
56 Notes
57 -----
58
59 Please note that Kirill Klenov’s python-mode_ ships its own version of this bundle.
60 Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using:
61
62 .. code-block:: vim
63
64    let g:pymode_indent = 0
65
66
67 License and Authorship
68 ----------------------
69
70 This script is based on one from vim’s official `script repo`_  that was *not* originally written by me.
71 Unfortunately the indentation was off by one character in one case and hasn’t been updated since 2005.
72
73 Even more unfortunately, I wasn’t able to reach any of the original authors/maintainers:
74 **David Bustos** and **Eric Mc Sween**.
75
76 So I fixed the annoyance it with the help of `Steve Losh`_ and am putting it out here so you don’t have to patch the original yourself.
77 The original patch is still available here_.
78
79 I’d like to thank the original authors here for their work and release it hereby to the *Public Domain* (using the CC0 licence) since I hope that would be in their spirit.
80 If anyone with a say in this objects, please let me_ know immediately.
81 Also, if someone is in contact with one of them, I would appreciate being introduced.
82
83 While my Vimscript_ skills are still feeble, I intend to maintain it for now.
84 This mainly means that I’ll triage through bugs and pull requests but won’t be fixing much myself.
85
86
87 .. _vim: http://www.vim.org/
88 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
89 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
90 .. _`Steve Losh`: http://stevelosh.com/
91 .. _here: https://gist.github.com/2965846
92 .. _Neobundle: https://github.com/Shougo/neobundle.vim
93 .. _Pathogen: https://github.com/tpope/vim-pathogen
94 .. _python-mode: https://github.com/klen/python-mode
95 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
96 .. _vundle: https://github.com/gmarik/Vundle.vim
97 .. _me: https://hynek.me/