docs: add module names to fix gO (#2064)

7 files changed, 37 insertions, 36 deletions

diff --git a/doc/telescope.txt b/doc/telescope.txt
index 5b2dcd5..2564854 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -1,5 +1,5 @@
 ================================================================================
-                                                                *telescope.nvim*
+INTRODUCTION                                                    *telescope.nvim*
 
 Telescope.nvim is a plugin for fuzzy finding and neovim. It helps you search,
 filter, find and pick things in Lua.
@@ -732,14 +732,6 @@ telescope.setup({opts})                                    *telescope.setup()*
                         extensions
 
 
-telescope.register_extension({mod})           *telescope.register_extension()*
-    Register an extension. To be used by plugin authors.
-
-
-    Parameters: ~
-        {mod} (table)  Module
-
-
 telescope.load_extension({name})                  *telescope.load_extension()*
     Load an extension.
     - Notes:
@@ -750,6 +742,14 @@ telescope.load_extension({name})                  *telescope.load_extension()*
         {name} (string)  Name of the extension
 
 
+telescope.register_extension({mod})           *telescope.register_extension()*
+    Register an extension. To be used by plugin authors.
+
+
+    Parameters: ~
+        {mod} (table)  Module
+
+
 telescope.extensions()                                *telescope.extensions()*
     Use telescope.extensions to reference any extensions within your
     configuration.
@@ -760,7 +760,7 @@ telescope.extensions()                                *telescope.extensions()*
 
 
 ================================================================================
-                                                             *telescope.command*
+COMMAND                                                      *telescope.command*
 
 Telescope commands can be called through two apis, the lua api and the viml
 api.
@@ -795,7 +795,7 @@ as there are spaces in the option.
 
 
 ================================================================================
-                                                             *telescope.builtin*
+BUILTIN                                                      *telescope.builtin*
 
 Telescope Builtins is a collection of community maintained pickers to support
 common workflows. It can be used as reference when writing PRs, Telescope
@@ -1671,7 +1671,7 @@ builtin.diagnostics({opts})                  *telescope.builtin.diagnostics()*
 
 
 ================================================================================
-                                                              *telescope.themes*
+THEMES                                                        *telescope.themes*
 
 Themes are ways to combine several elements of styling together.
 
@@ -1717,7 +1717,7 @@ themes.get_ivy()                                  *telescope.themes.get_ivy()*
 
 
 ================================================================================
-                                                              *telescope.layout*
+LAYOUT                                                        *telescope.layout*
 
 The layout of telescope pickers can be adjusted using the
 |telescope.defaults.layout_strategy| and |telescope.defaults.layout_config|
@@ -1966,7 +1966,7 @@ layout_strategies.bottom_pane()               *telescope.layout.bottom_pane()*
 
 
 ================================================================================
-                                                             *telescope.resolve*
+RESOLVE                                                      *telescope.resolve*
 
 Provides "resolver functions" to allow more customisable inputs for options.
 
@@ -2032,7 +2032,7 @@ resolver.resolve_anchor_pos()         *telescope.resolve.resolve_anchor_pos()*
 
 
 ================================================================================
-                                                          *telescope.make_entry*
+MAKE_ENTRY                                                *telescope.make_entry*
 
 Each picker has a finder made up of two parts, the results which are the data
 to be displayed, and the entry_maker. These entry_makers are functions returned
@@ -2068,7 +2068,7 @@ TODO: Document something we call `entry_index`
 
 
 ================================================================================
-                                               *telescope.pickers.entry_display*
+ENTRY_DISPLAY                                  *telescope.pickers.entry_display*
 
 Entry Display is used to format each entry shown in the result panel.
 
@@ -2127,7 +2127,7 @@ look at the code in make_entry.lua.
 
 
 ================================================================================
-                                                               *telescope.utils*
+UTILS                                                          *telescope.utils*
 
 Utilities for writing telescope pickers
 
@@ -2160,7 +2160,7 @@ utils.notify({funname}, {opts})                     *telescope.utils.notify()*
 
 
 ================================================================================
-                                                             *telescope.actions*
+ACTIONS                                                      *telescope.actions*
 
 Actions functions that are useful for people creating their own mappings.
 
@@ -2838,7 +2838,7 @@ actions.to_fuzzy_refine({prompt_bufnr})  *telescope.actions.to_fuzzy_refine()*
 
 
 ================================================================================
-                                                       *telescope.actions.state*
+ACTIONS_STATE                                          *telescope.actions.state*
 
 Functions to be used to determine the current state of telescope.
 
@@ -2864,7 +2864,7 @@ action_state.get_current_picker({prompt_bufnr}) *telescope.actions.state.get_cur
 
 
 ================================================================================
-                                                         *telescope.actions.set*
+ACTIONS_SET                                              *telescope.actions.set*
 
 Telescope action sets are used to provide an interface for managing actions
 that all primarily do the same thing, but with slight tweaks.
@@ -2929,7 +2929,7 @@ action_set.scroll_results({prompt_bufnr}, {direction}) *telescope.actions.set.sc
 
 
 ================================================================================
-                                                      *telescope.actions.layout*
+ACTIONS_LAYOUT                                        *telescope.actions.layout*
 
 The layout actions are actions to be used to change the layout of a picker.
 
@@ -2988,7 +2988,7 @@ action_layout.cycle_layout_prev({prompt_bufnr}) *telescope.actions.layout.cycle_
 
 
 ================================================================================
-                                                       *telescope.actions.utils*
+ACTIONS_UTILS                                          *telescope.actions.utils*
 
 Utilities to wrap functions around picker selections and entries.
 
@@ -3068,7 +3068,7 @@ utils.get_registered_mappings({prompt_bufnr}) *telescope.actions.utils.get_regis
 
 
 ================================================================================
-                                                    *telescope.actions.generate*
+ACTIONS_GENERATE                                    *telescope.actions.generate*
 
 Module for convenience to override defaults of corresponding
 |telescope.actions| at |telescope.setup()|.
@@ -3146,7 +3146,7 @@ action_generate.which_key({opts})     *telescope.actions.generate.which_key()*
 
 
 ================================================================================
-                                                          *telescope.previewers*
+PREVIEWERS                                                *telescope.previewers*
 
 Provides a Previewer table that has to be implemented by each previewer. To
 achieve this, this module also provides two wrappers that abstract most of the
@@ -3472,7 +3472,7 @@ previewers.display_content()          *telescope.previewers.display_content()*
 
 
 ================================================================================
-                                                     *telescope.actions.history*
+HISTORY                                              *telescope.actions.history*
 
 A base implementation of a prompt history that provides a simple history and
 can be replaced with a custom implementation.
diff --git a/lua/telescope/actions/generate.lua b/lua/telescope/actions/generate.lua
index 703c83d..672cc38 100644
--- a/lua/telescope/actions/generate.lua
+++ b/lua/telescope/actions/generate.lua
@@ -1,5 +1,5 @@
 ---@tag telescope.actions.generate
----@config { ["module"] = "telescope.actions.generate" }
+---@config { ["module"] = "telescope.actions.generate", ["name"] = "ACTIONS_GENERATE" }
 
 ---@brief [[
 --- Module for convenience to override defaults of corresponding |telescope.actions| at |telescope.setup()|.
diff --git a/lua/telescope/actions/layout.lua b/lua/telescope/actions/layout.lua
index f6f6b13..0e8b27a 100644
--- a/lua/telescope/actions/layout.lua
+++ b/lua/telescope/actions/layout.lua
@@ -1,5 +1,5 @@
 ---@tag telescope.actions.layout
----@config { ["module"] = "telescope.actions.layout" }
+---@config { ["module"] = "telescope.actions.layout", ["name"] = "ACTIONS_LAYOUT" }
 
 ---@brief [[
 --- The layout actions are actions to be used to change the layout of a picker.
diff --git a/lua/telescope/actions/set.lua b/lua/telescope/actions/set.lua
index 45d0a36..c2b25d5 100644
--- a/lua/telescope/actions/set.lua
+++ b/lua/telescope/actions/set.lua
@@ -1,5 +1,5 @@
 ---@tag telescope.actions.set
----@config { ["module"] = "telescope.actions.set" }
+---@config { ["module"] = "telescope.actions.set", ["name"] = "ACTIONS_SET" }
 
 ---@brief [[
 --- Telescope action sets are used to provide an interface for managing
diff --git a/lua/telescope/actions/state.lua b/lua/telescope/actions/state.lua
index 597e2f6..b07248a 100644
--- a/lua/telescope/actions/state.lua
+++ b/lua/telescope/actions/state.lua
@@ -1,5 +1,5 @@
 ---@tag telescope.actions.state
----@config { ["module"] = "telescope.actions.state" }
+---@config { ["module"] = "telescope.actions.state", ["name"] = "ACTIONS_STATE" }
 
 ---@brief [[
 --- Functions to be used to determine the current state of telescope.
diff --git a/lua/telescope/actions/utils.lua b/lua/telescope/actions/utils.lua
index 4e81db3..749b79b 100644
--- a/lua/telescope/actions/utils.lua
+++ b/lua/telescope/actions/utils.lua
@@ -1,5 +1,5 @@
 ---@tag telescope.actions.utils
----@config { ["module"] = "telescope.actions.utils" }
+---@config { ["module"] = "telescope.actions.utils", ["name"] = "ACTIONS_UTILS" }
 
 ---@brief [[
 --- Utilities to wrap functions around picker selections and entries.
diff --git a/lua/telescope/init.lua b/lua/telescope/init.lua
index 0cc2009..6ed7e66 100644
--- a/lua/telescope/init.lua
+++ b/lua/telescope/init.lua
@@ -90,6 +90,7 @@ local telescope = {}
 ---@brief ]]
 
 ---@tag telescope.nvim
+---@config { ["name"] = "INTRODUCTION" }
 
 --- Setup function to be run by user. Configures the defaults, pickers and
 --- extensions of telescope.
@@ -134,12 +135,6 @@ function telescope.setup(opts)
   _extensions.set_config(opts.extensions)
 end
 
---- Register an extension. To be used by plugin authors.
----@param mod table: Module
-function telescope.register_extension(mod)
-  return _extensions.register(mod)
-end
-
 --- Load an extension.
 --- - Notes:
 ---   - Loading triggers ext setup via the config passed in |telescope.setup|
@@ -148,6 +143,12 @@ function telescope.load_extension(name)
   return _extensions.load(name)
 end
 
+--- Register an extension. To be used by plugin authors.
+---@param mod table: Module
+function telescope.register_extension(mod)
+  return _extensions.register(mod)
+end
+
 --- Use telescope.extensions to reference any extensions within your configuration. <br>
 --- While the docs currently generate this as a function, it's actually a table. Sorry.
 telescope.extensions = require("telescope._extensions").manager