From dbca328c590a1aea6efb0dcfd6f594794a348b05 Mon Sep 17 00:00:00 2001 From: JINNOUCHI Yasushi Date: Thu, 5 Sep 2024 23:36:35 +0900 Subject: [PATCH] docs: add note for `bootstrap` (#261) * docs: remove unnecessary `main` from code example * docs: add note for `bootstrap` --- doc/telescope-frecency.txt | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/telescope-frecency.txt b/doc/telescope-frecency.txt index 671edb5..c35dfc1 100644 --- a/doc/telescope-frecency.txt +++ b/doc/telescope-frecency.txt @@ -332,7 +332,6 @@ register opened files as soon as Neovim has started. Example configuration for >lua { "nvim-telescope/telescope-frecency.nvim", - main = "frecency", -- `opts` property calls the plugin's setup() function. -- In this case, this calls frecency.setup(). opts = { @@ -418,6 +417,16 @@ Type: `boolean` If `true`, it removes stale entries count over than |telescope-frecency-configuration-db_validate_threshold|. + *telescope-frecency-configuration-bootstrap* +bootstrap ~ + +Default: `true` +Type: `boolean` + +If `true` and you set this plugin to be loaded non-lazily, it initializes DB in +Neovim startup (before |VimEnter|). This initialization logic works +asynchronously and does not block Neovim's starting process. + *telescope-frecency-configuration-db_root* db_root ~