add documentation for GitGutterGetHunkSummary.

Sambojambo · Aug 19, 2013 · bdaff53 · bdaff53
1 parent 8951f68
commit bdaff53
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/plugin/gitgutter.vim b/plugin/gitgutter.vim
@@ -576,6 +576,9 @@ function! GitGutterGetHunks()
   return s:is_active() ? s:hunks : []
 endfunction
 
+" Returns an array that contains a summary of the current hunk status.
+" The format is [ added, modified, removed ], where each value represents
+" the number of lines added/modified/removed respectively.
 function! GitGutterGetHunkSummary()
   return s:hunk_summary
 endfunction