From 2e36a8bdb8ec1d7d4eb395f8222ee74b8de350e7 Mon Sep 17 00:00:00 2001 From: itchyny Date: Sat, 31 Aug 2013 22:50:59 +0900 Subject: [PATCH] Note for other plugins --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9dfaea6..4564533 100644 --- a/README.md +++ b/README.md @@ -709,3 +709,18 @@ let g:unite_force_overwrite_statusline = 0 let g:vimfiler_force_overwrite_statusline = 0 let g:vimshell_force_overwrite_statusline = 0 ``` + +### Note for other plugins +Appearance consistency matters. + +The statusline is an important space for Vim users. +Overwriting the statusline forcibly in your plugin is not a good idea. +It is not hospitality, but just an annoying feature. +If your plugin has such a feature, add an option to be modest. + +A good design is the following. +Firstly, give the users a clue to judge which buffer is the one your plugin creates. +The filename is a manner and the filetype is another. +Then, export a function which is useful to be shown in the statusline. +Lastly, for advanced users, set important information in buffer variables. +So that the users can obtain the condition of the plugin freely.