From 6d82af8c6daf73e5026b50d3e132adc217c2bf61 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Wed, 29 May 2019 02:36:58 +1200 Subject: Condense and solidify documentation --- README.md | 5 ++--- doc/shebang_change_filetype.txt | 11 +++++------ plugin/shebang_change_filetype.vim | 4 ++-- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3f6524a..f168f1d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ shebang\_change\_filetype.vim ============================= -This plugin watches the first line of a buffer for the presence of a "shebang", -beginning with the characters "#!". If such a line is added or modified, -filetype detection is re-run. +This plugin re-runs filetype detection if a shebang `#!` is added or changed in +the buffer. License ------- diff --git a/doc/shebang_change_filetype.txt b/doc/shebang_change_filetype.txt index 0d84d95..d26f02a 100644 --- a/doc/shebang_change_filetype.txt +++ b/doc/shebang_change_filetype.txt @@ -1,15 +1,14 @@ -*shebang_change_filetype.txt* For Vim version 7.0 Last change: 2019 May 20 +*shebang_change_filetype.txt* For Vim version 7.0 Last change: 2019 May 28 DESCRIPTION *shebang_change_filetype* -This plugin watches the first line of a buffer for the presence of a -"shebang", beginning with the characters "#!". If such a line is added or -modified, filetype detection is re-run. +This plugin re-runs |filetype| detection if a shebang `#!` is added or changed +in the buffer. REQUIREMENTS *shebang_change_filetype-requirements* -This plugin only loads if 'compatible' is not set, and requires the |+autocmd| -feature. It works best if the |TextChanged| event is also available. +This plugin only loads if 'compatible' is not set. It works best if the +|TextChanged| event is supported. AUTHOR *shebang_change_filetype-author* diff --git a/plugin/shebang_change_filetype.vim b/plugin/shebang_change_filetype.vim index a27cb70..03f5830 100644 --- a/plugin/shebang_change_filetype.vim +++ b/plugin/shebang_change_filetype.vim @@ -1,6 +1,6 @@ " -" shebang_change_filetype.vim: On leaving insert mode, check whether the first -" line was changed and looks like a shebang format. +" shebang_change_filetype.vim: Re-run filetype detection if a shebang #! is +" added or changed in the buffer. " " Author: Tom Ryder " License: Same as Vim itself -- cgit v1.2.3