From 25d01edae8a2d74bcaa706c003b2712bce1e3301 Mon Sep 17 00:00:00 2001
From: JINNOUCHI Yasushi <me@delphinus.dev>
Date: Fri, 2 Aug 2024 18:20:41 +0900
Subject: [PATCH] docs: add note for disabling the dialog (#235)

See https://www.reddit.com/r/neovim/comments/1egczrs/how_to_sort_files_in_telescope_by_showing_the/
---
 doc/telescope-frecency.txt | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/doc/telescope-frecency.txt b/doc/telescope-frecency.txt
index 52dcf07..0d0008d 100644
--- a/doc/telescope-frecency.txt
+++ b/doc/telescope-frecency.txt
@@ -13,6 +13,7 @@ Function		|telescope-frecency-function|
 Configuration		|telescope-frecency-configuration|
 Database		|telescope-frecency-database|
 Highlight Groups	|telescope-frecency-highlight-groups|
+FAQ			|telescope-frecency-faq|
 Reference		|telescope-frecency-reference|
 
 
@@ -789,6 +790,35 @@ Default: link to |hl-WildMenu|
 This is used to highlight query filter such as `:CWD:`.
 
 
+==============================================================================
+FAQ							*telescope-frecency-faq*
+
+			     *telescope-frecency-faq-removenentriesfromdatabase*
+“remove n entries from database?” dialog appears in startup ~
+
+This dialog informs you that this plugin will delete entries because stale
+ones exist in DB.
+
+If you feel this annoying, you can disable it by config. See
+|telescope-frecency-configuration-db_safe_mode|,
+|telescope-frecency-configuration-auto_validate|.
+>lua
+    {
+      "nvim-telescope/telescope.nvim",
+      config = function()
+	local telescope = require "telescope"
+	telescope.setup {
+	  extensions = {
+	    frecency = {
+	      -- completely disable the dialog
+	      db_safe_mode = false,
+	    },
+	  },
+	}
+	telescope.load_extension "frecency"
+      end,
+    }
+
 ==============================================================================
 REFERENCE					  *telescope-frecency-reference*