From: Simon Ruderich <simon@ruderich.org>
Date: Fri, 30 Oct 2009 08:59:09 +0000 (+0100)
Subject: vimrc: Documentation updates.
X-Git-Url: https://ruderich.org/simon/gitweb/?a=commitdiff_plain;h=c8549a38306000d76450d02f220c322117e62ba7;p=config%2Fdotfiles.git

vimrc: Documentation updates.
---

diff --git a/vimrc b/vimrc
index 1dfdbfc..a3c95d3 100644
--- a/vimrc
+++ b/vimrc
@@ -22,7 +22,7 @@ set wildmode=longest,list
 
 " EDIT SETTINGS
 
-" Enable automatic file detection, plugin and indention.
+" Enable automatic file detection, plugin and indention support.
 if has('autocmd')
     filetype plugin indent on
 endif
@@ -86,14 +86,15 @@ if v:version >= 700 && !&diff
     set spelllang=en_us
 endif
 
-" Allow buffers with changes to be hidden.
+" Allow buffers with changes to be hidden. Very important for effective
+" editing with multiple buffers.
 set hidden
 
 
 " DISPLAY SETTINGS
 
-" Use a dark background. Doesn't change the background color, only sets colors
-" for a dark terminal.
+" Use a dark background. Doesn't change the background color, only sets text
+" colors for a dark terminal.
 set background=dark
 
 " Display line numbers.
@@ -194,7 +195,7 @@ endif
 if has('syntax')
     syntax enable
 
-" Highlight text longer than 78 characters. Thanks to Tony Mechelynck
+" Highlight lines longer than 78 characters. Thanks to Tony Mechelynck
 " <antoine.mechelynck@gmail.com> from the Vim mailing list.
 " It can easily be disabled if necessary with :2match (in Vim >= 700).
     if v:version >= 700
@@ -256,7 +257,7 @@ if has('autocmd')
 
 " FTDETECT AUTO COMMANDS
 
-" Recognize .md as markdown files.
+" Recognize .md as markdown files (Vim default is .mkd).
         autocmd BufRead,BufNewFile *.md set filetype=mkd
 " Recognize .test as Tcl files.
         autocmd BufRead,BufNewFile *.test set filetype=tcl