From 531b80b83bd075505eb5382ca8c91cd2281639eb Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alexis=20Laferri=C3=A8re?= Date: Sat, 11 Apr 2015 10:21:51 -0400 Subject: [PATCH] misc/vim: update README file MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Alexis Laferrière --- misc/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/misc/README.md b/misc/README.md index 1661f43..9b4bf06 100644 --- a/misc/README.md +++ b/misc/README.md @@ -98,13 +98,15 @@ the environment variable `NIT_VIM_DIR`. ## Documentation in preview window -You can display the documentation for the entity under the cursor with `:call Nitdoc()`. -It will use the same metadata files as the omnifunc and the preview window. +The command `:Nitdoc` searches the documentation for the word under the cursor. +The results are displayed in the preview window in order of relevance. +You can search for any word by passing it as an argument, as in `:Nitdoc modulo`. +The Nitdoc command uses the same metadata files as the omnifunc. You may want to map the function to a shortcut by adding the following code to `~/.vimrc`. ~~~ " Map displaying Nitdoc to Ctrl-D -map :call Nitdoc() +map :Nitdoc ~~~ ## Search declarations and usages of the word under the cursor -- 1.7.9.5