docs(summary): remove old type def (#1567)

nvim-neorg · Sep 2, 2024 · d5965ef · d5965ef
1 parent 85f15f0
commit d5965ef
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/lua/neorg/core/callbacks.lua b/lua/neorg/core/callbacks.lua
@@ -1,5 +1,5 @@
 --- @brief [[
---- Defines user callbacks - ways for the user to directly interact with Neorg and respon on certain events.
+--- Defines user callbacks - ways for the user to directly interact with Neorg and respond on certain events.
 --- @brief ]]
 
 --- @module "neorg.core.modules"

diff --git a/lua/neorg/modules/core/summary/module.lua b/lua/neorg/modules/core/summary/module.lua
@@ -300,7 +300,9 @@ module.config.public = {
     -- - "default" - read the metadata to categorize and annotate files. Files
     --   without metadata will use the top level heading as the title. If no headings are present, the filename will be used.
     -- - "by_path" - Similar to "default" but uses the capitalized name of the folder containing a *.norg file as category.
-    ---@type string|fun(files: PathlibPath[], ws_root: PathlibPath, heading_level: number?, include_categories: string[]?): string[]?
+    -- - A custom function with the signature:
+    --   `fun(files: PathlibPath[], ws_root: PathlibPath, heading_level: number?, include_categories: string[]?): string[]?`.
+    --   Returning a list of lines that make up the summary
     strategy = "default",
 }