docs: add module prefix (#1847)
This commit is contained in:
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.actions.generate
|
||||
---@config { ["module"] = "telescope.actions.generate" }
|
||||
|
||||
---@brief [[
|
||||
--- Module for convenience to override defaults of corresponding |telescope.actions| at |telescope.setup()|.
|
||||
|
||||
@@ -4,6 +4,9 @@ local utils = require "telescope.utils"
|
||||
|
||||
local uv = vim.loop
|
||||
|
||||
---@tag telescope.actions.history
|
||||
---@config { ["module"] = "telescope.actions.history" }
|
||||
|
||||
---@brief [[
|
||||
--- A base implementation of a prompt history that provides a simple history
|
||||
--- and can be replaced with a custom implementation.
|
||||
@@ -22,7 +25,6 @@ local uv = vim.loop
|
||||
---
|
||||
--- See github.com/nvim-telescope/telescope-smart-history.nvim
|
||||
---@brief ]]
|
||||
---@tag telescope.actions.history
|
||||
|
||||
-- TODO(conni2461): currently not present in plenary path only sync.
|
||||
-- But sync is just unnecessary here
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
---@tag telescope.actions
|
||||
|
||||
-- TODO: Add @module to make it so we can have the prefix.
|
||||
--@module telescope.actions
|
||||
---@config { ["module"] = "telescope.actions" }
|
||||
|
||||
---@brief [[
|
||||
--- Actions functions that are useful for people creating their own mappings.
|
||||
@@ -12,7 +10,6 @@
|
||||
--- (1) The `prompt_bufnr` of a normal function denotes the identifier of your
|
||||
--- picker which can be used to access the picker state. In practice, users
|
||||
--- most commonly access from both picker and global state via the following:
|
||||
---
|
||||
--- <code>
|
||||
--- -- for utility functions
|
||||
--- local action_state = require "telescope.actions.state"
|
||||
@@ -28,7 +25,6 @@
|
||||
---
|
||||
--- (2) To transform a module of functions into a module of "action"s, you need
|
||||
--- to do the following:
|
||||
---
|
||||
--- <code>
|
||||
--- local transform_mod = require("telescope.actions.mt").transform_mod
|
||||
---
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.actions.layout
|
||||
---@config { ["module"] = "telescope.actions.layout" }
|
||||
|
||||
---@brief [[
|
||||
--- The layout actions are actions to be used to change the layout of a picker.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.actions.set
|
||||
---@config { ["module"] = "telescope.actions.set" }
|
||||
|
||||
---@brief [[
|
||||
--- Telescope action sets are used to provide an interface for managing
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.actions.state
|
||||
---@config { ["module"] = "telescope.actions.state" }
|
||||
|
||||
---@brief [[
|
||||
--- Functions to be used to determine the current state of telescope.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.actions.utils
|
||||
---@config { ["module"] = "telescope.actions.utils" }
|
||||
|
||||
---@brief [[
|
||||
--- Utilities to wrap functions around picker selections and entries.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---@tag telescope.builtin
|
||||
|
||||
---@config { ['field_heading'] = "Options" }
|
||||
---@config { ['field_heading'] = "Options", ["module"] = "telescope.builtin" }
|
||||
|
||||
---@brief [[
|
||||
--- Telescope Builtins is a collection of community maintained pickers to support common workflows. It can be used as
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.command
|
||||
---@config { ["module"] = "telescope.command" }
|
||||
|
||||
---@brief [[
|
||||
---
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.resolve
|
||||
---@config { ["module"] = "telescope.resolve" }
|
||||
|
||||
---@brief [[
|
||||
--- Provides "resolver functions" to allow more customisable inputs for options.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.layout
|
||||
---@config { ["module"] = "telescope.layout" }
|
||||
|
||||
---@brief [[
|
||||
--- The layout of telescope pickers can be adjusted using the
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---@tag telescope.previewers
|
||||
---@config { ["module"] = "telescope.previewers" }
|
||||
|
||||
---@brief [[
|
||||
--- Provides a Previewer table that has to be implemented by each previewer.
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
-- local opts = themes.get_dropdown { winblend = 3 }
|
||||
|
||||
---@tag telescope.themes
|
||||
---@config { ["module"] = "telescope.themes" }
|
||||
|
||||
---@brief [[
|
||||
--- Themes are ways to combine several elements of styling together.
|
||||
|
||||
Reference in New Issue
Block a user