docs: fixed action comments

folke · Mar 27, 2024 · 0a8746b · 0a8746b
1 parent 89b0427
commit 0a8746b
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lua/trouble/docs.lua b/lua/trouble/docs.lua
@@ -88,9 +88,15 @@ function M.api()
       desc = action.desc or desc
       action = action.action
     end
+    desc = table.concat(
+      vim.tbl_map(function(line)
+        return ("--- %s"):format(line)
+      end, vim.split(desc, "\n")),
+      "\n"
+    )
     if type(action) == "function" and not vim.tbl_contains(exclude, k) then
       funcs[#funcs + 1] = ([[
---- %s
+%s
 ---@param opts? trouble.Mode | { new? : boolean } | string
 ---@return trouble.View
 require("trouble").%s(opts)]]):format(desc, k)