Rooba
/
cpython
mirror of https://github.com/python/cpython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cpython/Misc/vimrc

95 lines
3.6 KiB
VimL
Raw Normal View History

Comment cleanup.
2004-11-06 19:56:45 +00:00
" vimrc file for following the coding standards specified in PEP 7 & 8.
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
"
" To use this file, source it in your own personal .vimrc file (``source
" <filename>``) or, if you don't have a .vimrc file, you can just symlink to it
Comment cleanup.
2004-11-06 19:56:45 +00:00
" (``ln -s <this file> ~/.vimrc``). All options are protected by autocmds
" (read below for an explanation of the command) so blind sourcing of this file
" is safe and will not affect your settings for non-Python or non-C files.
"
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
"
" All setting are protected by 'au' ('autocmd') statements. Only files ending
" in .py or .pyw will trigger the Python settings while files ending in *.c or
Add a highlight group for denoting bad whitespace. Also added a match rule for leading tabs in a line when in Python mode. Also fixed some grammatical errors in the comments.
2005-03-05 05:52:21 +00:00
" *.h will trigger the C settings. This makes the file "safe" in terms of only
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
" adjusting settings for Python and C files.
"
" Only basic settings needed to enforce the style guidelines are set.
" Some suggested options are listed but commented out at the end of this file.
" Number of spaces to use for an indent.
" This will affect Ctrl-T and 'autoindent'.
" Python: 4 spaces
" C: tab (8 spaces)
au BufRead,BufNewFile *.py,*pyw set shiftwidth=4
au BufRead,BufNewFile *.c,*.h set shiftwidth=8
" Number of spaces that a pre-existing tab is equal to.
Comment cleanup.
2004-11-06 19:56:45 +00:00
" For the amount of space used for a new tab use shiftwidth.
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
" Python: 8
" C: 8
au BufRead,BufNewFile *py,*pyw,*.c,*.h set tabstop=8
" Replace tabs with the equivalent number of spaces.
" Also have an autocmd for Makefiles since they require hard tabs.
" Python: yes
" C: no
Comment cleanup.
2004-11-06 19:56:45 +00:00
" Makefile: no
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
au BufRead,BufNewFile *.py,*.pyw set expandtab
au BufRead,BufNewFile *.c,*.h set noexpandtab
au BufRead,BufNewFile Makefile* set noexpandtab
Add a highlight group for denoting bad whitespace. Also added a match rule for leading tabs in a line when in Python mode. Also fixed some grammatical errors in the comments.
2005-03-05 05:52:21 +00:00
" Use the below highlight group when displaying bad whitespace is desired
highlight BadWhitespace ctermbg=red guibg=red
" Display tabs at the beginning of a line in Python mode as bad
au BufRead,BufNewFile *.py,*.pyw match BadWhitespace /^\t\+/
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
" Wrap text after a certain number of characters
" Python: 79
" C: 79
au BufRead,BufNewFile *.py,*.pyw,*.c,*.h set textwidth=79
" Turn off settings in 'formatoptions' relating to comment formatting.
" - c : do not automatically insert the comment leader when wrapping based on
" 'textwidth'
" - o : do not insert the comment leader when using 'o' or 'O' from command mode
" - r : do not insert the comment leader when hitting <Enter> in insert mode
" Python: not needed
" C: prevents insertion of '*' at the beginning of every line in a comment
au BufRead,BufNewFile *.c,*.h set formatoptions-=c formatoptions-=o formatoptions-=r
" Use UNIX (\n) line endings.
" Only used for new files so as to not force existing files to change their
" line endings.
" Python: yes
" C: yes
au BufNewFile *.py,*.pyw,*.c,*.h set fileformat=unix
Comment cleanup.
2004-11-06 19:56:45 +00:00
" ----------------------------------------------------------------------------
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
" The following section contains suggested settings. While in no way required
" to meet coding standards, they are helpful.
" Set the default file encoding to UTF-8: ``set encoding=utf-8``
Add a highlight group for denoting bad whitespace. Also added a match rule for leading tabs in a line when in Python mode. Also fixed some grammatical errors in the comments.
2005-03-05 05:52:21 +00:00
" Puts a marker at the beginning of the file to differentiate between UTF and
Comment cleanup.
2004-11-06 19:56:45 +00:00
" UCS encoding (WARNING: can trick shells into thinking a text file is actually
" a binary file when executing the text file): ``set bomb``
When this file is sourced in, or used as, one's vimrc file it will set the proper settings to follow the style guidelines laid out in PEPs 7 & 8 as best it can without forcing extraneous settings. Suggested settings are commented out and included at the end of the file. The goal is to have this file prevent as much as possible from deviating from the style guidelines. It is not meant to collect every cool macro possible for Python. Any useful settings for features included with Vim can be included and commented out, but anything overly extraneous should be left out.
2004-09-19 05:43:13 +00:00
" For full syntax highlighting:
"``let python_highlight_all=1``
"``syntax on``
" Automatically indent: ``filetype indent on``
Comment cleanup.
2004-11-06 19:56:45 +00:00
" Folding based on indentation: ``set foldmethod=indent``
Add a commented-out recipe on making trailing whitespace explicit. If people think this is not too intrusive it could be uncommented.
2004-09-20 22:33:21 +00:00
Add a highlight group for denoting bad whitespace. Also added a match rule for leading tabs in a line when in Python mode. Also fixed some grammatical errors in the comments.
2005-03-05 05:52:21 +00:00
" Make trailing whitespace explicit (left off since this will automatically
" insert the highlight or characters *as you type*, which can get annoying):
"``match BadWhitespace /\s\+$/``
"
" or, for a non-colored, character-based solution:
"
"``set list listchars=trail:-``
Add a commented-out recipe on making trailing whitespace explicit. If people think this is not too intrusive it could be uncommented.
2004-09-20 22:33:21 +00:00