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

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:

92771b716cd3edd4fae7c92b08560eb273009636
[etc/vim.git] / README.md
1 ## vim-python-pep8-indent                                                          
2
3 <a href="https://travis-ci.org/hynek/vim-python-pep8-indent">                      
4     <img src=https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis />
5 </a>                                                                               
6
7
8 This small script modifies [vim][vim]’s indentation behavior to comply with [PEP8][pep8] and 
9 my aesthetic preferences:                                                          
10
11 ```python                                                                          
12 foobar(foo,                           
13        bar)                                                                        
14 ```                                                                                
15
16 and                                                                                
17
18 ```python                                                                          
19 foobar(                                                                            
20     foo,                                                                           
21     bar                                                                            
22 )                                                                                  
23 ```                                                                                
24
25 It was *not* originally written by me. I have found the script in vim’s [script 
26 repo][script_repo], however the indentation was off by one character in the first case.
27
28 I fixed it with the help of [Steve Losh][steve_losh] and am putting it out here so you 
29 don’t have to patch the original. The original patch is still available [here][patch].
30
31 While my [Vimscript][vimscript] skills are still feeble, I intend to maintain it for now.
32 So feel free to report bugs, I’ll try to address them as well as I can, provided
33 they fit into the scope of this project.                                           
34
35 Unfortunately, I wasn’t able to reach any of the original authors/maintainers:  
36 **David Bustos** and **Eric Mc Sween**. I’d like to thank them here for their   
37 work and release it hereby to the *Public Domain*. If anyone with a say in this 
38 objects, please let me know.                                                       
39
40 ### Installation                                                                   
41
42 #### Pathogen                                                                      
43 cd to `~/.vim/bundle` and                                                          
44 ```                                                                                
45 git clone https://github.com/hynek/vim-python-pep8-indent.git                      
46 ```                                                                                
47
48 #### Vundle                                                                        
49
50 Follow the instructions on installing [Vundle][vundle] and add the appropriate  
51 plugin line:                                                                       
52
53 ```                                                                                
54 Plugin 'hynek/vim-python-pep8-indent`                                              
55 ```                                                                                
56
57 #### NeoBundle                                                                     
58
59 Follow the instructions on installing [NeoBundle][neobundle] and add the appropriate
60 NeoBundle line:                                                                    
61
62 ```                                                                                
63 NeoBundle 'hynek/vim-python-pep8-indent`                                           
64 ```                                                                                
65
66 ### Notes                                                                          
67
68 Please note that Kirill Klenov’s [python-mode][python_mode]ships an own version of this bundle.
69 Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using
70
71 ```                                                                                
72 let g:pymode_indent = 0                                                            
73 ```                                                                                
74
75 [vim]: http://www.vim.org/                                                         
76 [pep8]: http://www.python.org/dev/peps/pep-0008/                                   
77 [script_repo]: http://www.vim.org/scripts/script.php?script_id=974                 
78 [steve_losh]: http://stevelosh.com/                                                
79 [patch]: https://gist.github.com/2965846                                           
80 [vimscript]: http://learnvimscriptthehardway.stevelosh.com/                        
81 [pathogen]: https://github.com/tpope/vim-pathogen                                  
82 [python_mode]: https://github.com/klen/python-mode                                 
83 [vundle]: https://github.com/gmarik/Vundle.vim