docs: Add explanatory comment

andrewferrier · Aug 17, 2022 · bc43d6f · bc43d6f
1 parent 9601502
commit bc43d6f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lua/debugprint/init.lua b/lua/debugprint/init.lua
@@ -97,6 +97,9 @@ local debugprint_addline = function(opts)
         line_to_insert_content = fixes.left .. debuginfo() .. fixes.right
     end
 
+    -- Inserting the leading space from the current line effectively acts as a
+    -- 'default' indent for languages like Python, where the NeoVim or Treesitter
+    -- indenter doesn't know how to indent them.
     local current_line = vim.api.nvim_get_current_line()
     local leading_space = current_line:match('(%s+)') or ''