docs: add note for FrecencyOpts (#208)

* docs: add lacked help tags

* docs: add FrecencyOpts and its explanation
This commit is contained in:
JINNOUCHI Yasushi
2024-06-01 11:46:19 +09:00
committed by GitHub
parent 8783a062f7
commit 14cb823ec2
2 changed files with 41 additions and 0 deletions

View File

@@ -166,6 +166,7 @@ or to map to a key:
Filter tags are applied by typing the `:tag:` name (adding surrounding colons)
in the finder query. Entering `:<Tab>` will trigger omni completion |compl-omni|.
*telescope-frecency-usage-dealing-with-uppercase-letters*
------------------------------------------------------------------------------
Dealing with upper case letters
@@ -228,6 +229,24 @@ You can call `setup()` with these configuration settings below.
},
},
}
<
*telescope-frecency-configuration-frecencyopts*
*FrecencyOpts*
`FrecencyOpts` is a convenient type to use your own configuration. With using
this in the type annotation, you can complete items by LSP in writing.
NOTE: You need a properly configured Language Server for this feature such as
lua-ls. https://github.com/LuaLS/lua-language-server
>lua
require("telescope").setup {
extensions = {
---@type FrecencyOpts
frecency = {
auto_validate = false,
-- …… other configs
}
},
}
<
*telescope-frecency-configuration-auto_validate*
auto_validate ~