add comments for utils.norm_path

Author: alex-courtis

lua/nvim-tree/utils.lua

@@ -10,7 +10,6 @@ local has_cygpath = vim.fn.executable "cygpath" == 1
 M.is_unix = vim.fn.has "unix" == 1
 M.is_macos = vim.fn.has "mac" == 1 or vim.fn.has "macunix" == 1
 M.is_wsl = vim.fn.has "wsl" == 1
--- false for WSL
 M.is_windows = vim.fn.has "win32" == 1 or vim.fn.has "win32unix" == 1
 
 function M.path_to_matching_str(path)
@@ -44,6 +43,11 @@ function M.path_split(path)
   return path:gmatch("[^" .. path_separator .. "]+" .. path_separator .. "?")
 end
 
+--- Normalise a path:
+---  windows: replace slashes with backslashes
+---   cygwin: resolve path first via cygpath
+--- @param path string
+--- @return string|nil nil on cygpath failure
 function M.norm_path(path)
   if M.is_windows then
     -- msys2 git support