From 562c9ce6fbbd6fc8b9c5e470121dcc8e731de21e Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sat, 4 Nov 2017 17:39:23 +1300 Subject: Use same comment boilerplate for custom plugins A brief explanation, an author name, and the license should do fine. --- vim/autoload/detect_background.vim | 10 ++++++++-- vim/plugin/big_file.vim | 1 - vim/plugin/command_typos.vim | 5 +++++ vim/plugin/copy_linebreak.vim | 2 ++ vim/plugin/fixed_join.vim | 5 +++++ vim/plugin/strip_trailing_whitespace.vim | 5 +++++ 6 files changed, 25 insertions(+), 3 deletions(-) (limited to 'vim') diff --git a/vim/autoload/detect_background.vim b/vim/autoload/detect_background.vim index a1a2c208..89e5d19e 100644 --- a/vim/autoload/detect_background.vim +++ b/vim/autoload/detect_background.vim @@ -1,5 +1,11 @@ -" Invert Vim's built-in logic for choosing dark or light backgrounds; we'll -" default to choosing a dark background unless we find some reason *not* to. +" +" detect_background.vim: Invert Vim's built-in logic for choosing dark or +" light backgrounds; we'll default to choosing a dark background unless we +" find some reason *not* to. +" +" Author: Tom Ryder +" License: Same as Vim itself +" function! detect_background#DetectBackground() " Split up the value of $COLORFGBG (if any) by semicolons diff --git a/vim/plugin/big_file.vim b/vim/plugin/big_file.vim index 5ccad7d2..ec30158a 100644 --- a/vim/plugin/big_file.vim +++ b/vim/plugin/big_file.vim @@ -3,7 +3,6 @@ " loading quickly. " " Author: Tom Ryder -" Copyright: 2017 " License: Same as Vim itself " if has('eval') && has('autocmd') diff --git a/vim/plugin/command_typos.vim b/vim/plugin/command_typos.vim index 592392ab..32d194fb 100644 --- a/vim/plugin/command_typos.vim +++ b/vim/plugin/command_typos.vim @@ -1,6 +1,11 @@ +" " Tolerate typos like :Wq, :Q, or :Qa and do what I mean, including any " arguments or modifiers; I fat-finger these commands a lot because I type " them so rapidly, and they don't correspond to any other commands I use +" +" Author: Tom Ryder +" License: Same as Vim itself +" if has('eval') && has('user_commands') command! -bang -complete=file -nargs=? E e command! -bang -complete=file -nargs=? W w diff --git a/vim/plugin/copy_linebreak.vim b/vim/plugin/copy_linebreak.vim index cba2c866..1dc537d4 100644 --- a/vim/plugin/copy_linebreak.vim +++ b/vim/plugin/copy_linebreak.vim @@ -3,6 +3,8 @@ " showbreak characters and breakindent mode on and off, for convenience of " copying multiple lines from terminal emulators. " +" Author: Tom Ryder +" License: Same as Vim itself " if has('eval') diff --git a/vim/plugin/fixed_join.vim b/vim/plugin/fixed_join.vim index 81e61614..c002f667 100644 --- a/vim/plugin/fixed_join.vim +++ b/vim/plugin/fixed_join.vim @@ -1,5 +1,10 @@ +" " User-defined key mapping to keep cursor in place when joining lines in " normal mode +" +" Author: Tom Ryder +" License: Same as Vim itself +" if has('eval') " Declare function diff --git a/vim/plugin/strip_trailing_whitespace.vim b/vim/plugin/strip_trailing_whitespace.vim index 36e1d2ad..17fff33f 100644 --- a/vim/plugin/strip_trailing_whitespace.vim +++ b/vim/plugin/strip_trailing_whitespace.vim @@ -1,4 +1,9 @@ +" " User-defined key mapping to strip trailing whitespace in the whole document +" +" Author: Tom Ryder +" License: Same as Vim itself +" if has('eval') " Define function for stripping whitespace -- cgit v1.2.3