nerdtree

A tree explorer plugin for vim.
Index Commits Files Refs
commit 8f052c5b47dce01ec04bed580226fd18da32def4
parent 1e93f6840a4cbbbf1130ae56357d92fc90055036
Author: Jason Franklin <j_fra@fastmail.us>
Date:   Sat,  6 Jan 2018 09:23:27 -0500

Simplify the commentary for the "getPath()" method

Diffstat:
Mlib/nerdtree/ui.vim | 13++++---------
1 file changed, 4 insertions(+), 9 deletions(-)
diff --git a/lib/nerdtree/ui.vim b/lib/nerdtree/ui.vim
@@ -141,15 +141,10 @@ function! s:UI.New(nerdtree)
 endfunction
 
 " FUNCTION: s:UI.getPath(ln) {{{1
-" Gets the full path to the node that is rendered on the given line number
-"
-" Args:
-" ln: the line number to get the path for
-"
-" Return:
-" A path if a node was selected, {} if nothing is selected.
-" If the 'up a dir' line was selected then the path to the parent of the
-" current root is returned
+" Return the "Path" object for the node that is rendered on the given line
+" number.  If the "up a dir" line is selected, return the "Path" object for
+" the parent of the root.  Return the empty dictionary if the given line
+" does not reference a tree node.
 function! s:UI.getPath(ln)
     let line = getline(a:ln)