From f6dad4796e30cd1960dc2bed230e69c20f02313c Mon Sep 17 00:00:00 2001 From: Jason Franklin Date: Fri, 22 Dec 2017 09:15:07 -0500 Subject: [PATCH] Update the documentation The docs for ":NERDTreeFind" are updated. Some additional formatting changes are made to other sections. --- doc/NERDTree.txt | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/doc/NERDTree.txt b/doc/NERDTree.txt index f68880c..38fbad9 100644 --- a/doc/NERDTree.txt +++ b/doc/NERDTree.txt @@ -126,20 +126,20 @@ The following features and functionality are provided by the NERD tree: Changes made to one tree are reflected in both as they are actually the same buffer. - If only one other NERD tree exists, that tree is automatically mirrored. If - more than one exists, the script will ask which tree to mirror. + If only one other NERD tree exists, that tree is automatically mirrored. + If more than one exists, the script will ask which tree to mirror. :NERDTreeClose *:NERDTreeClose* Close the NERD tree in this tab. -:NERDTreeFind *:NERDTreeFind* - Find the current file in the tree. +:NERDTreeFind [] *:NERDTreeFind* + Without the optional argument, find and reveal the file for the active + buffer in the NERDTree window. With the argument, find and + reveal the specified path. - If no tree exists and the current file is under vim's CWD, then init a - tree at the CWD and reveal the file. Otherwise init a tree in the current - file's directory. - - In any case, the current file is revealed and the cursor is placed on it. + Focus will be shifted to the NERDTree window, and the cursor will be + placed on the tree node for the determined path. If a NERDTree for the + current tab does not exist, a new one will be initialized. :NERDTreeCWD *:NERDTreeCWD* Change tree root to current directory. If no NERD tree exists for this @@ -1128,13 +1128,12 @@ NERDTreeAddKeyMap({options}) *NERDTreeAddKeyMap()* Additionally, a "scope" argument may be supplied. This constrains the mapping so that it is only activated if the cursor is on a certain object. That object is then passed into the handling method. Possible values are: - "FileNode" - a file node - "DirNode" - a directory node - "Node" - a file or directory node - "Bookmark" - A bookmark - "all" - the keymap is not constrained to any scope (default). When - thei is used, the handling function is not passed any arguments. + "FileNode" .... a file node + "DirNode" ..... a directory node + "Node" ........ a file node OR a directory node + "Bookmark" .... a bookmark + "all" ......... global scope; handler receives no arguments (default) Example: > call NERDTreeAddKeyMap({