diff options
author | Tom Ryder <tom@sanctum.geek.nz> | 2017-11-04 17:57:39 +1300 |
---|---|---|
committer | Tom Ryder <tom@sanctum.geek.nz> | 2017-11-04 17:59:54 +1300 |
commit | dae845727dbb3a7f91137d85d322ee475d604289 (patch) | |
tree | 4fe5abe81f0ce3087dc38ec69a9cad36222b840a /vim/doc/flag_toggle.txt | |
parent | Use same comment boilerplate for custom plugins (diff) | |
download | dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.tar.gz dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.zip |
Add short documentation for new custom plugins
I'm using the plugin_name.txt syntax suggested by the Vim documentation.
That may change in future as I study plugins written by experienced
authors like Tim Pope.
There will almost certainly be a lot more detail to add to each of
these.
Diffstat (limited to 'vim/doc/flag_toggle.txt')
-rw-r--r-- | vim/doc/flag_toggle.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/vim/doc/flag_toggle.txt b/vim/doc/flag_toggle.txt new file mode 100644 index 00000000..5f1b504a --- /dev/null +++ b/vim/doc/flag_toggle.txt @@ -0,0 +1,15 @@ +*flag_toggle.txt* Functions to toggle single-character flags in options + +Author: Tom Ryder <tom@sanctum.geek.nz> +License: Same terms as Vim itself (see |license|) + +This plugin provides functions flag_toggle#Toggle(option, flag) and +flag_toggle#ToggleLocal(option, flag) to toggle the values of options like +|'formatoptions'| or |'complete'| that have values comprised of +single-character flags. The author originally designed it for toggling flags in +|'formatoptions'| quickly. + +This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +off into a separate distribution as it solidifies and this documentation +improves. + |