chore: fix a few docgen warnings (#1658)

Author: benlubas

docgen/docgen.lua

@@ -37,6 +37,7 @@ local lib, modules, utils, log = neorg.lib, neorg.modules, neorg.utils, neorg.lo
 neorg.org_file_entered(false)
 
 -- Extract treesitter utility functions provided by Neorg and nvim-treesitter.ts_utils
+---@type core.integrations.treesitter
 local ts = modules.get_module("core.integrations.treesitter")
 assert(ts, "treesitter not available")
 

lua/neorg/modules/core/completion/module.lua

@@ -44,7 +44,7 @@ module.config.public = {
     -- - `{ module_name = "external.lsp-completion" }` this must be used with
     --   [neorg-interim-ls](https://github.com/benlubas/neorg-interim-ls) and can provide
     --   completions through a shim Language Server. This allows users without an auto complete
-    --   plugin to still get neorg completions
+    --   plugin to still get Neorg completions
     engine = nil,
 
     -- The identifier for the Neorg source.

lua/neorg/modules/core/integrations/treesitter/module.lua

@@ -496,7 +496,7 @@ module.public = {
     --- Recursively attempts to locate a node of a given type
     ---@param type string #The type of node to look for
     ---@param opts table #A table of two options: `buf` and `ft`, for the buffer and format respectively
-    ---@return any ---@diagnostic disable-line -- TODO: type error workaround <pysan3>
+    ---@return TSNode?
     get_first_node_recursive = function(type, opts)
         opts = opts or {}
         local result

lua/neorg/modules/core/qol/toc/module.lua

@@ -59,36 +59,36 @@ module.load = function()
 end
 
 module.config.public = {
-    -- close the Table of Contents after an entry in the table is picked
+    -- Close the Table of Contents after an entry in the table is picked
     close_after_use = false,
 
-    -- width of the Table of Contents window will automatically fit its longest line, up to
+    -- Width of the Table of Contents window will automatically fit its longest line, up to
     -- `max_width`
     fit_width = true,
 
-    -- max width of the ToC window when `fit_width = true` (in columns)
+    -- Max width of the ToC window when `fit_width = true` (in columns)
     max_width = 30,
 
-    -- when set, the ToC window will always be this many cols wide.
+    -- When set, the ToC window will always be this many cols wide.
     -- will override `fit_width` and ignore `max_width`
     fixed_width = nil,
 
-    -- enable `cursorline` in the ToC window, and sync the cursor position between ToC and content
+    -- Enable `cursorline` in the ToC window, and sync the cursor position between ToC and content
     -- window
     sync_cursorline = true,
 
     -- Enter a ToC window opened manually (any ToC window not opened by auto_toc)
     enter = true,
 
-    -- options for automatically opening/entering the ToC window
+    -- Options for automatically opening/entering the ToC window
     auto_toc = {
-        -- automatically open a ToC window when entering any `norg` buffer
+        -- Automatically open a ToC window when entering any `norg` buffer
         open = false,
-        -- enter an automatically opened ToC window
+        -- Enter an automatically opened ToC window
         enter = false,
-        -- automatically close the ToC window when there is no longer an open norg buffer
+        -- Automatically close the ToC window when there is no longer an open norg buffer
         close = true,
-        -- will exit nvim if the ToC is the last buffer on the screen, similar to help windows
+        -- Will exit nvim if the ToC is the last buffer on the screen, similar to help windows
         exit_nvim = true,
     },
 }