From 9e31143b66cc44a93f3e369b671ace64e38bb8a5 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 12 Nov 2017 22:41:23 +1300 Subject: 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. --- vim/doc/toggle_option_flag.txt | 40 +++++++++++++++++++++++++++++----------- 1 file changed, 29 insertions(+), 11 deletions(-) (limited to 'vim/doc/toggle_option_flag.txt') diff --git a/vim/doc/toggle_option_flag.txt b/vim/doc/toggle_option_flag.txt index 9415ae6b..928a233b 100644 --- a/vim/doc/toggle_option_flag.txt +++ b/vim/doc/toggle_option_flag.txt @@ -1,17 +1,35 @@ -*toggle_option_flag.txt* Commands to toggle option flags +*toggle_option_flag.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *toggle_option_flag* -This plugin provides commands :ToggleOptionFlag and :ToggleOptionFlagLocal to -toggle the values of options like |'formatoptions'| or |'complete'| that have -values comprised of single-character or comma-separated flags. The author +This plugin provides commands `:ToggleOptionFlag` and `:ToggleOptionFlagLocal` +to toggle the values of options like |'formatoptions'| or |'complete'| that +have values comprised of single-character or comma-separated flags. The author originally designed it for toggling flags in |'formatoptions'| quickly. - :ToggleOptionFlag formatoptions a - :ToggleOptionFlag switchbuf useopen - :ToggleOptionFlagLocal shortmess I +EXAMPLES *toggle_option_flag-examples* +> + :ToggleOptionFlag formatoptions a + :ToggleOptionFlag switchbuf useopen + :ToggleOptionFlagLocal shortmess I +< +REQUIREMENTS *toggle_option_flag-requirements* -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +This plugin is only available if 'compatible' is not set. + +AUTHOR *toggle_option_flag-author* + +Written and maintained by Tom Ryder . + +LICENSE *toggle_option_flag-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *toggle_option_flag-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 for more +information. + + vim:tw=78:ts=8:ft=help:norl: -- cgit v1.2.3 From b9edd9073ca84e6efb78e9ed014744488682da57 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 12 Nov 2017 23:22:27 +1300 Subject: Add help links to toggle_option_flag.vim interface --- vim/doc/toggle_option_flag.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'vim/doc/toggle_option_flag.txt') diff --git a/vim/doc/toggle_option_flag.txt b/vim/doc/toggle_option_flag.txt index 928a233b..7587abd0 100644 --- a/vim/doc/toggle_option_flag.txt +++ b/vim/doc/toggle_option_flag.txt @@ -2,6 +2,7 @@ DESCRIPTION *toggle_option_flag* + *:ToggleOptionFlag* *:ToggleOptionFlagLocal* This plugin provides commands `:ToggleOptionFlag` and `:ToggleOptionFlagLocal` to toggle the values of options like |'formatoptions'| or |'complete'| that have values comprised of single-character or comma-separated flags. The author -- cgit v1.2.3 From 93d353a2b568a28102729945dfa3504a21d3fb63 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 12 Nov 2017 23:22:46 +1300 Subject: Adjust first sentence of format_option_toggle.txt --- vim/doc/toggle_option_flag.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'vim/doc/toggle_option_flag.txt') diff --git a/vim/doc/toggle_option_flag.txt b/vim/doc/toggle_option_flag.txt index 7587abd0..c8bf7678 100644 --- a/vim/doc/toggle_option_flag.txt +++ b/vim/doc/toggle_option_flag.txt @@ -3,7 +3,7 @@ DESCRIPTION *toggle_option_flag* *:ToggleOptionFlag* *:ToggleOptionFlagLocal* -This plugin provides commands `:ToggleOptionFlag` and `:ToggleOptionFlagLocal` +This plugin provides `:ToggleOptionFlag` and `:ToggleOptionFlagLocal` commands to toggle the values of options like |'formatoptions'| or |'complete'| that have values comprised of single-character or comma-separated flags. The author originally designed it for toggling flags in |'formatoptions'| quickly. -- cgit v1.2.3 From fa93fdc38b3456eab847d1f3190492583b705f8d Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 12 Nov 2017 23:23:16 +1300 Subject: Mention req of toggle_option_flag.vim --- vim/doc/toggle_option_flag.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'vim/doc/toggle_option_flag.txt') diff --git a/vim/doc/toggle_option_flag.txt b/vim/doc/toggle_option_flag.txt index c8bf7678..be035221 100644 --- a/vim/doc/toggle_option_flag.txt +++ b/vim/doc/toggle_option_flag.txt @@ -16,7 +16,8 @@ EXAMPLES *toggle_option_flag-examples* < REQUIREMENTS *toggle_option_flag-requirements* -This plugin is only available if 'compatible' is not set. +This plugin is only available if 'compatible' is not set. It also requires the +|+user_commands| Vim feature. AUTHOR *toggle_option_flag-author* -- cgit v1.2.3