Add a comment for the watcher callback nil filename check.

lewis6991 · Aug 9, 2023 · d3d7654 · d3d7654
1 parent ffcdbc6
commit d3d7654
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lua/gitsigns/watcher.lua b/lua/gitsigns/watcher.lua
@@ -116,6 +116,9 @@ function M.watch_gitdir(bufnr, gitdir)
 
     local info = string.format("Git dir update: '%s' %s", filename, inspect(events))
 
+    -- The luv docs say filename is passed as a string but it has been observed
+    -- to sometimes be nil.
+    --    https://github.com/lewis6991/gitsigns.nvim/issues/848
     if filename == nil or vim.endswith(filename, '.lock') then
       dprintf('%s (ignoring)', info)
       return