aboutsummaryrefslogtreecommitdiff
path: root/vim/doc/strip_trailing_whitespace.txt
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-12 22:41:23 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-12 22:41:23 +1300
commit9e31143b66cc44a93f3e369b671ace64e38bb8a5 (patch)
treee105daedd523f4301ca55e013736813c548d1fd3 /vim/doc/strip_trailing_whitespace.txt
parentUpdate and correct detect_background.vim help (diff)
downloaddotfiles-9e31143b66cc44a93f3e369b671ace64e38bb8a5.tar.gz
dotfiles-9e31143b66cc44a93f3e369b671ace64e38bb8a5.zip
Apply boilerplate to Vim plugin docs
The DESCRIPTION heading for each of these is filled out now, but some of them probably need a bit more explanation. The mail_mutt.txt plugin is good, though.
Diffstat (limited to 'vim/doc/strip_trailing_whitespace.txt')
-rw-r--r--vim/doc/strip_trailing_whitespace.txt26
1 files changed, 21 insertions, 5 deletions
diff --git a/vim/doc/strip_trailing_whitespace.txt b/vim/doc/strip_trailing_whitespace.txt
index d50fbfb7..f7ea1a95 100644
--- a/vim/doc/strip_trailing_whitespace.txt
+++ b/vim/doc/strip_trailing_whitespace.txt
@@ -1,7 +1,6 @@
-*strip_trailing_whitespace.txt* Strip trailing whitespace from whole buffer
+*strip_trailing_whitespace.txt* For Vim version 7.0 Last change: 2017 November 12
-Author: Tom Ryder <tom@sanctum.geek.nz>
-License: Same terms as Vim itself (see |license|)
+DESCRIPTION *strip_trailing_whitespace*
This plugin is the author's approach to stripping trailing whitespace from an
entire buffer, including empty lines at the end, without making command noise
@@ -10,6 +9,23 @@ and without moving the cursor from its current position.
If also provides a :StripTrailingWhitespace command if you have +user_commands,
but this is not required.
-This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+REQUIREMENTS *strip_trailing_whitespace-requirements*
+
+This plugin is only available if 'compatible' is not set.
+
+AUTHOR *strip_trailing_whitespace-author*
+
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+
+LICENSE *strip_trailing_whitespace-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+DISTRIBUTION *strip_trailing_whitespace-distribution*
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun
off into a separate distribution as it solidifies and this documentation
-improves.
+improves. See <https://sanctum.geek.nz/cgit/dotfiles.git/about/> for more
+information.
+
+ vim:tw=78:ts=8:ft=help:norl: